Certificate - Refresh Secret
En KeyVault, actualice el certificado que se usa para la autenticación con el 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 identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
certificate
|
path | True |
string |
Identificador de la entidad de certificado. Debe ser único en la instancia de servicio API Management actual. Patrón de Regex: |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Patrón de Regex: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Los detalles del certificado se actualizaron correctamente. Encabezados ETag: string |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
ApiManagementRefreshCertificate
Solicitud de ejemplo
Respuesta de muestra
{
"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"
}
}
}
}
Definiciones
Nombre | Description |
---|---|
Certificate |
Detalles del certificado. |
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Key |
Detalles del contrato de KeyVault. |
Key |
Emitir propiedades de actualización de contrato. |
CertificateContract
Detalles del certificado.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nombre del recurso. |
properties.expirationDate |
string |
Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: |
properties.keyVault |
Detalles de ubicación de KeyVault del certificado. |
|
properties.subject |
string |
Atributo Subject del certificado. |
properties.thumbprint |
string |
Huella digital del certificado |
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Contrato de campo de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error de nivel de propiedad. |
message |
string |
Representación legible del error de nivel de propiedad. |
target |
string |
Nombre de propiedad. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error.code |
string |
Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta. |
error.details |
La lista de campos no válidos que se envían en la solicitud, en caso de error de validación. |
|
error.message |
string |
Representación legible del error. |
KeyVaultContractProperties
Detalles del contrato de KeyVault.
Nombre | Tipo | Description |
---|---|---|
identityClientId |
string |
Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity , que se usará para acceder al secreto del almacén de claves. |
lastStatus |
Última sincronización y actualización del estado del secreto desde el almacén de claves. |
|
secretIdentifier |
string |
Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Emitir propiedades de actualización de contrato.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Último código de estado para la sincronización y actualización del secreto desde el almacén de claves. |
message |
string |
Detalles del error vacío. |
timeStampUtc |
string |
Última vez que se obtuvo acceso al secreto. La fecha se ajusta al siguiente formato: |