Gateway Certificate Authority - Create Or Update

Serviço:

API Management

Versão da API:

2024-05-01

Atribua a entidade de Certificado à entidade de Gateway como Autoridade de Certificação.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}?api-version=2024-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador da entidade certificadora. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
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		string	ETag da Entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Corpo do Pedido

Name	Tipo	Description
properties.isTrusted	boolean	Determina se a autoridade de certificação é confiável.

Respostas

Name	Tipo	Description
200 OK	GatewayCertificateAuthorityContract	Os detalhes da Autoridade de Certificação do Gateway foram atualizados com êxito Cabeçalhos ETag: string
201 Created	GatewayCertificateAuthorityContract	A entidade de certificação foi atribuída com êxito à entidade de gateway como autoridade de certificação. Cabeçalhos ETag: string
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

ApiManagementCreateGatewayCertificateAuthority

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1?api-version=2024-05-01

{
  "properties": {
    "isTrusted": false
  }
}

Resposta da amostra

Código de estado:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "name": "cert1",
  "properties": {
    "isTrusted": false
  }
}

Código de estado:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "name": "cert1",
  "properties": {
    "isTrusted": false
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GatewayCertificateAuthorityContract	Detalhes da autoridade de certificação do gateway.

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.

GatewayCertificateAuthorityContract

Object

Detalhes da autoridade de certificação do gateway.

Name	Tipo	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.isTrusted	boolean	Determina se a autoridade de certificação é confiável.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"