Certificate - Refresh Secret
A KeyVaultban frissítse a háttérrendszerbeli hitelesítéshez használt tanúsítványt.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
certificate
|
path | True |
string |
A tanúsítványentitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Reguláris kifejezési minta: |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Reguláris kifejezési minta: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A tanúsítvány részletei sikeresen frissültek. Fejlécek ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
ApiManagementRefreshCertificate
Mintakérelem
Mintaválasz
{
"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"
}
}
}
}
Definíciók
Name | Description |
---|---|
Certificate |
Tanúsítvány részletei. |
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Key |
KeyVault-szerződés részletei. |
Key |
Szerződés frissítési tulajdonságainak kiállítása. |
CertificateContract
Tanúsítvány részletei.
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.expirationDate |
string |
A tanúsítvány lejárati dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak |
properties.keyVault |
A tanúsítvány KeyVault-helyadatai. |
|
properties.subject |
string |
A tanúsítvány tulajdonosattribútuma. |
properties.thumbprint |
string |
A tanúsítványhoz tartozó ujjlenyomat. |
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
KeyVaultContractProperties
KeyVault-szerződés részletei.
Name | Típus | Description |
---|---|---|
identityClientId |
string |
Null érték a SystemAssignedIdentity vagy a UserAssignedIdentity ügyfél-azonosítója esetében, amely a Key Vault titkos kulcsainak eléréséhez lesz használva. |
lastStatus |
A key vault titkos kulcsának legutóbbi szinkronizálási és frissítési állapota. |
|
secretIdentifier |
string |
Titkos kulcstartó-azonosító a titkos kód lekéréséhez. A verziószámozott titkos kód megadása megakadályozza az automatikus frissítést. Ehhez API Management szolgáltatást kell konfigurálni aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Szerződés frissítési tulajdonságainak kiállítása.
Name | Típus | Description |
---|---|---|
code |
string |
Utolsó állapotkód a key vault titkos kódjának szinkronizálásához és frissítéséhez. |
message |
string |
A hiba részletei üresek. |
timeStampUtc |
string |
A titkos kód legutóbbi elérésének időpontja. A dátum az ISO 8601 szabvány által meghatározott formátumnak |