Certificate - Refresh Secret
V části KeyVault aktualizujte certifikát, který se používá k ověřování s back-endem.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
certificate
|
path | True |
string |
Identifikátor entity certifikátu. Musí být v aktuální instanci služby API Management jedinečná. Vzor regulárního výrazu: |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Podrobnosti o certifikátu se úspěšně aktualizovaly. Hlavičky ETag: string |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
ApiManagementRefreshCertificate
Ukázkový požadavek
Ukázková odpověď
{
"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"
}
}
}
}
Definice
Name | Description |
---|---|
Certificate |
Podrobnosti o certifikátu. |
Error |
Chyba Kontrakt pole. |
Error |
Odpověď na chybu. |
Key |
Podrobnosti o kontraktu KeyVault. |
Key |
Vyřešte smlouvu o aktualizaci vlastností. |
CertificateContract
Podrobnosti o certifikátu.
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Název prostředku |
properties.expirationDate |
string |
Datum vypršení platnosti certifikátu. Datum odpovídá následujícímu formátu: |
properties.keyVault |
Podrobnosti o umístění certifikátu keyVault. |
|
properties.subject |
string |
Atribut předmětu certifikátu. |
properties.thumbprint |
string |
Kryptografický otisk certifikátu |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
ErrorFieldContract
Chyba Kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Čitelné znázornění chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v žádosti v případě chyby ověření. |
|
error.message |
string |
Znázornění chyby čitelné pro člověka |
KeyVaultContractProperties
Podrobnosti o kontraktu KeyVault.
Name | Typ | Description |
---|---|---|
identityClientId |
string |
Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , které se použije pro přístup k tajnému kódu trezoru klíčů. |
lastStatus |
Čas poslední synchronizace a stav aktualizace tajného kódu z trezoru klíčů |
|
secretIdentifier |
string |
Identifikátor tajného klíče trezoru klíčů pro načtení tajného klíče Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Vyřešte smlouvu o aktualizaci vlastností.
Name | Typ | Description |
---|---|---|
code |
string |
Poslední stavový kód pro synchronizaci a aktualizaci tajného kódu z trezoru klíčů. |
message |
string |
Podrobnosti o chybě jsou prázdné. |
timeStampUtc |
string |
Čas posledního přístupu k tajnému kódu Datum odpovídá následujícímu formátu: |