Partilhar via


Certificate - Create Or Update

Cria ou atualiza o certificado que está sendo usado para autenticação com o back-end.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}?api-version=2022-08-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.

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

minLength: 1

A ID da assinatura de destino.

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.data

string

Certificado codificado Base 64 usando a representação application/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes do local do KeyVault do certificado.

properties.password

string

Senha para o certificado

Respostas

Name Tipo Description
200 OK

CertificateContract

Os detalhes do certificado foram atualizados com êxito.

Cabeçalhos

ETag: string

201 Created

CertificateContract

O novo certificado foi adicionado com êxito.

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

ApiManagementCreateCertificate
ApiManagementCreateCertificateWithKeyVault

ApiManagementCreateCertificate

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert?api-version=2022-08-01

{
  "properties": {
    "data": "****************Base 64 Encoded Certificate *******************************",
    "password": "****Certificate Password******"
  }
}

Resposta da amostra

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}

ApiManagementCreateCertificateWithKeyVault

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv?api-version=2022-08-01

{
  "properties": {
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert"
    }
  }
}

Resposta da amostra

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "templateCertkv",
  "properties": {
    "subject": "CN=*.msitesting.net",
    "thumbprint": "EA**********************9AD690",
    "expirationDate": "2037-01-01T07:00:00Z",
    "keyVault": {
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
      }
    }
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "templateCertkv",
  "properties": {
    "subject": "CN=*.msitesting.net",
    "thumbprint": "EA**********************9AD690",
    "expirationDate": "2037-01-01T07:00:00Z",
    "keyVault": {
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
      }
    }
  }
}

Definições

Name Description
CertificateContract

Detalhes do certificado.

CertificateCreateOrUpdateParameters

Detalhes de criação ou atualização de certificados.

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato do keyVault.

KeyVaultContractProperties

Detalhes do contrato KeyVault.

KeyVaultLastAccessStatusContractProperties

Emitir contrato Atualizar Propriedades.

CertificateContract

Detalhes do certificado.

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.expirationDate

string (date-time)

Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.

properties.keyVault

KeyVaultContractProperties

Detalhes do local do KeyVault do certificado.

properties.subject

string

Atributo de assunto do certificado.

properties.thumbprint

string

Impressão digital do certificado.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CertificateCreateOrUpdateParameters

Detalhes de criação ou atualização de certificados.

Name Tipo Description
properties.data

string

Certificado codificado Base 64 usando a representação application/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes do local do KeyVault do certificado.

properties.password

string

Senha para o certificado

ErrorFieldContract

Contrato de campo de erro.

Name Tipo Description
code

string

Código de erro de nível de propriedade.

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código serve como um substatus para o código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados em solicitação, em caso de erro de validação.

error.message

string

Representação legível por humanos do erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato do keyVault.

Name Tipo Description
identityClientId

string

Nulo para SystemAssignedIdentity ou ID do Cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves.

secretIdentifier

string

Identificador secreto do cofre de chaves para buscar segredo. Fornecer um segredo versionado impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi

KeyVaultContractProperties

Detalhes do contrato KeyVault.

Name Tipo Description
identityClientId

string

Nulo para SystemAssignedIdentity ou ID do Cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves.

lastStatus

KeyVaultLastAccessStatusContractProperties

Última sincronização e atualização do status do segredo do cofre de chaves.

secretIdentifier

string

Identificador secreto do cofre de chaves para buscar segredo. Fornecer um segredo versionado impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Emitir contrato Atualizar Propriedades.

Name Tipo Description
code

string

Último código de status para sincronização e atualização do segredo do cofre de chaves.

message

string

Os detalhes do erro estão vazios.

timeStampUtc

string (date-time)

Da última vez o segredo foi acessado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.