Portal Config - Update

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Atualize a configuração do portal do desenvolvedor.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}?api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
portalConfigId	path	True	string minLength: 1 maxLength: 80	Identificador de configuração do portal.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match	True	string	ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

Corpo da solicitação

Nome	Tipo	Description
properties.cors	PortalConfigCorsProperties	As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.
properties.csp	PortalConfigCspProperties	As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.
properties.delegation	PortalConfigDelegationProperties	As configurações de delegação do portal do desenvolvedor.
properties.enableBasicAuth	boolean	Habilitar ou desabilitar o método de autenticação Básica.
properties.signin	Signin
properties.signup	Signup

Respostas

Nome	Tipo	Description
200 OK	PortalConfigContract	Operação concluída com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementUpdatePortalConfig

Solicitação de exemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default?api-version=2024-05-01


{
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default",
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "name": "default",
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PortalConfigContract	O contrato de configuração do portal do desenvolvedor.
PortalConfigCorsProperties	As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.
PortalConfigCspProperties	As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Termos de propriedades do contrato de serviço.
PortalSettingsCspMode	O modo da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.
Signin
Signup

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PortalConfigContract

Objeto

O contrato de configuração do portal do desenvolvedor.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.cors	PortalConfigCorsProperties		As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.
properties.csp	PortalConfigCspProperties		As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.
properties.delegation	PortalConfigDelegationProperties		As configurações de delegação do portal do desenvolvedor.
properties.enableBasicAuth	boolean	True	Habilitar ou desabilitar o método de autenticação Básica.
properties.signin	Signin
properties.signup	Signup
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Objeto

As configurações de CORS (Compartilhamento de Recursos entre Origens) do portal do desenvolvedor.

Nome	Tipo	Description
allowedOrigins	string[]	Origens permitidas, por exemplo, `https://trusted.com`.

PortalConfigCspProperties

Objeto

As configurações da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.

Nome	Tipo	Valor padrão	Description
allowedSources	string[]		Fontes permitidas, por exemplo, `*.trusted.com`, `trusted.com`, `https://`.
mode	PortalSettingsCspMode	disabled	O modo da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.
reportUri	string[]		As URLs usadas pelo navegador para relatar violações de CSP.

PortalConfigDelegationProperties

Objeto

Nome	Tipo	Valor padrão	Description
delegateRegistration	boolean	False	Habilitar ou desabilitar a delegação para o registro do usuário.
delegateSubscription	boolean	False	Habilitar ou desabilitar a delegação para assinaturas de produtos.
delegationUrl	string		Uma URL de ponto de extremidade de delegação.
validationKey	string		Uma chave de validação codificada em base64 para garantir que as solicitações se originem do serviço de Gerenciamento de API do Azure.

PortalConfigTermsOfServiceProperties

Objeto

Termos de propriedades do contrato de serviço.

Nome	Tipo	Valor padrão	Description
requireConsent	boolean	False	Peça ao usuário consentimento para os termos de serviço.
text	string		Um texto de termos de serviço.

PortalSettingsCspMode

Enumeração

O modo da CSP (Política de Segurança de Conteúdo) do portal do desenvolvedor.

Valor	Description
disabled	O navegador não aplicará as restrições de origem.
enabled	O navegador bloqueará solicitações que não correspondem às origens permitidas.
reportOnly	O navegador relatará solicitações que não correspondem às origens permitidas sem bloqueá-las.

Objeto

Nome	Tipo	Valor padrão	Description
require	boolean	False	Redirecione usuários anônimos para a página de entrada.

Objeto

Nome	Tipo	Description
termsOfService	PortalConfigTermsOfServiceProperties	Termos de configurações de serviço.

Compartilhar via

Portal Config - Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementUpdatePortalConfig

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Recursos adicionais

Compartilhar via

Portal Config - Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementUpdatePortalConfig

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Signin

Signup

Recursos adicionais