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 do URI

Name	Em	Necessá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 um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name	Tipo	Description
properties.cors	PortalConfigCorsProperties	As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.
properties.csp	PortalConfigCspProperties	As configurações da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.
properties.delegation	PortalConfigDelegationProperties	As configurações de delegação do portal do desenvolvedor.
properties.enableBasicAuth	boolean	Habilite ou desabilite o método de autenticação Básico.
properties.signin	Signin
properties.signup	Signup

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementUpdatePortalConfig

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PortalConfigContract	O contrato de configuração do portal do desenvolvedor.
PortalConfigCorsProperties	As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.
PortalConfigCspProperties	As configurações da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Termos de propriedade do contrato de serviços.
PortalSettingsCspMode	O modo da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.
Signin
Signup

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

PortalConfigContract

Object

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

Name	Tipo	Default value	Description
id	string		ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.cors	PortalConfigCorsProperties		As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.
properties.csp	PortalConfigCspProperties		As configurações da Política de Segurança de Conteúdo (CSP) do portal do desenvolvedor.
properties.delegation	PortalConfigDelegationProperties		As configurações de delegação do portal do desenvolvedor.
properties.enableBasicAuth	boolean	True	Habilite ou desabilite o método de autenticação Básico.
properties.signin	Signin
properties.signup	Signup
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Object

As configurações do CORS (Cross-Origin Resource Sharing) do portal do desenvolvedor.

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

PortalConfigCspProperties

Object

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

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

PortalConfigDelegationProperties

Object

Name	Tipo	Default value	Description
delegateRegistration	boolean	False	Habilite ou desabilite a delegação para registro de usuário.
delegateSubscription	boolean	False	Habilite ou desabilite 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 sejam originadas do serviço de Gerenciamento de API do Azure.

PortalConfigTermsOfServiceProperties

Object

Termos de propriedade do contrato de serviços.

Name	Tipo	Default value	Description
requireConsent	boolean	False	Peça ao utilizador o consentimento para os termos de serviço.
text	string		Um texto de termos de serviço.

PortalSettingsCspMode

Enumeração

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

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

Object

Name	Tipo	Default value	Description
require	boolean	False	Redirecione utilizadores anónimos para a página de início de sessão.

Object

Name	Tipo	Description
termsOfService	PortalConfigTermsOfServiceProperties	Configurações de termos de serviço.

Partilhar via

Portal Config - Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementUpdatePortalConfig

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Recursos adicionais

Partilhar via

Portal Config - Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementUpdatePortalConfig

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Signin

Signup

Recursos adicionais