Workspace Certificate - Refresh Secret

Serviço:

API Management

Versão da API:

2024-05-01

No KeyVault, atualize o certificado que está sendo usado para autenticação com o back-end.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}/refreshSecret?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.
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.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador de workspace. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	CertificateContract	Os detalhes do certificado foram atualizados com êxito. 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

ApiManagementRefreshWorkspaceCertificate

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv/refreshSecret?api-version=2024-05-01

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/workspaces/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

Nome	Description
CertificateContract	Detalhes do certificado.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
KeyVaultContractProperties	Detalhes do contrato KeyVault.
KeyVaultLastAccessStatusContractProperties	Emitir propriedades de atualização do contrato.

CertificateContract

Objeto

Detalhes do certificado.

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.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 pelo padrão ISO 8601.
properties.keyVault	KeyVaultContractProperties	Detalhes do local do KeyVault do certificado.
properties.subject	string	Atributo da entidade 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"

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.

KeyVaultContractProperties

Objeto

Detalhes do contrato KeyVault.

Nome	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	Da última vez, sincronize e atualize o status do segredo do cofre de chaves.
secretIdentifier	string	Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com versão impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Objeto

Emitir propriedades de atualização do contrato.

Nome	Tipo	Description
code	string	Último código de status para sincronização e atualização do segredo do cofre de chaves.
message	string	Detalhes do erro vazio.
timeStampUtc	string (date-time)	Última vez que o segredo foi acessado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.