Certificate - Refresh Secret
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}/certificates/{certificateId}/refreshSecret?api-version=2022-08-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
certificate
|
path | True |
string |
Identificador da entidade de certificado. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. Regex pattern: |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Regex pattern: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Os detalhes do certificado foram atualizados com êxito. Headers ETag: string |
|
Other Status Codes |
Resposta de erro que descreve por que 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
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
ApiManagementRefreshCertificate
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv/refreshSecret?api-version=2022-08-01
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"
}
}
}
}
Definições
Nome | Description |
---|---|
Certificate |
Detalhes do certificado. |
Error |
Contrato de campo de erro. |
Error |
Resposta de erro. |
Key |
Detalhes do contrato do KeyVault. |
Key |
Emitir propriedades de atualização de contrato. |
CertificateContract
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 |
Data de validade do certificado. A data está em conformidade com o seguinte formato: |
properties.keyVault |
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 |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Contrato de campo de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da 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.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
KeyVaultContractProperties
Detalhes do contrato do KeyVault.
Nome | Tipo | Description |
---|---|---|
identityClientId |
string |
Null para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves. |
lastStatus |
Da última vez, sincronize e atualize status de 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 Gerenciamento de API serviço seja configurado com aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Emitir propriedades de atualização de contrato.
Nome | Tipo | Description |
---|---|---|
code |
string |
O último status código para sincronização e atualização do segredo do cofre de chaves. |
message |
string |
Detalhes do erro vazio. |
timeStampUtc |
string |
A última vez que o segredo foi acessado. A data está em conformidade com o seguinte formato: |