Partilhar via


Certificate - Create Or Update

Cria ou atualiza o certificado que está a ser utilizado 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

Identificador da entidade de certificado. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName
path True

string

O nome do serviço Gestão de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

A versão da API a utilizar 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 com a representação application/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes de localização do KeyVault do certificado.

properties.password

string

Palavra-passe do Certificado

Respostas

Name Tipo Description
200 OK

CertificateContract

Os detalhes do certificado foram atualizados com êxito.

Headers

ETag: string

201 Created

CertificateContract

O novo certificado foi adicionado com êxito.

Headers

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ApiManagementCreateCertificate
ApiManagementCreateCertificateWithKeyVault

ApiManagementCreateCertificate

Sample Request

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******"
  }
}

Sample Response

{
  "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

Sample Request

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"
    }
  }
}

Sample Response

{
  "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 do Erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato keyVault.

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

KeyVaultLastAccessStatusContractProperties

Emitir Propriedades de Atualização do contrato.

CertificateContract

Detalhes do certificado.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.expirationDate

string

Data de expiração 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 de localização do KeyVault do certificado.

properties.subject

string

Atributo do requerente 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 com a representação application/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes de localização do KeyVault do certificado.

properties.password

string

Palavra-passe do 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 ao nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name Tipo Description
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

KeyVaultContractCreateProperties

Crie detalhes do contrato keyVault.

Name Tipo Description
identityClientId

string

Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves.

secretIdentifier

string

Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

Name Tipo Description
identityClientId

string

Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves.

lastStatus

KeyVaultLastAccessStatusContractProperties

Da última vez, sincronize e atualize o estado do segredo do cofre de chaves.

secretIdentifier

string

Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Emitir Propriedades de Atualização do contrato.

Name Tipo Description
code

string

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

message

string

Os detalhes do erro estão vazios.

timeStampUtc

string

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