Compartilhar via

Gateway Certificate Authority - Create Or Update

  • Referência
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 de URI

Nome Em Obrigatório Tipo Description
certificateId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Identificador da entidade de certificado. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
gatewayId
 path True

string

minLength: 1
maxLength: 80

Identificador de entidade de gateway. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Não deve ter o 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 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

string

ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Nome Tipo Description
properties.isTrusted

boolean

Determina se a autoridade de certificação é confiável.

Respostas

Nome 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 certificado foi atribuída com êxito à entidade gateway como Autoridade de Certificação.

Cabeçalhos

ETag: string
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

ApiManagementCreateGatewayCertificateAuthority

Solicitação de exemplo

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 de exemplo

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

Nome Description
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
GatewayCertificateAuthorityContract

Detalhes da autoridade de certificação do gateway.

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.

GatewayCertificateAuthorityContract

Objeto

Detalhes da autoridade de certificação do gateway.

Nome Tipo 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.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"