Certificate - Refresh Secret
Vernieuw vanuit KeyVault het certificaat dat wordt gebruikt voor verificatie met de back-end.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret?api-version=2022-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
certificate
|
path | True |
string |
Id van de certificaatentiteit. Moet uniek zijn in het huidige API Management service-exemplaar. Regex pattern: |
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
service
|
path | True |
string |
De naam van de API Management service. Regex pattern: |
subscription
|
path | True |
string |
De id van het doelabonnement. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De certificaatgegevens zijn bijgewerkt. Headers ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
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"
}
}
}
}
Definities
Name | Description |
---|---|
Certificate |
Certificaatdetails. |
Error |
Fout veldcontract. |
Error |
Foutreactie. |
Key |
Details van het KeyVault-contract. |
Key |
Update-eigenschappen van contract uitgeven. |
CertificateContract
Certificaatdetails.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
De naam van de resource |
properties.expirationDate |
string |
Vervaldatum van het certificaat. De datum voldoet aan de volgende notatie: |
properties.keyVault |
KeyVault-locatiedetails van het certificaat. |
|
properties.subject |
string |
Onderwerpkenmerk van het certificaat. |
properties.thumbprint |
string |
Vingerafdruk van het certificaat. |
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
ErrorFieldContract
Fout veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
KeyVaultContractProperties
Details van het KeyVault-contract.
Name | Type | Description |
---|---|---|
identityClientId |
string |
Null voor SystemAssignedIdentity of Client-id voor UserAssignedIdentity , die wordt gebruikt voor toegang tot het sleutelkluisgeheim. |
lastStatus |
De laatste keer synchroniseren en vernieuwen van de status van het geheim uit de sleutelkluis. |
|
secretIdentifier |
string |
Sleutelkluisgeheim-id voor het ophalen van het geheim. Als u een geheim met versie op geeft, wordt automatisch vernieuwen voorkomen. Hiervoor moet API Management service worden geconfigureerd met aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Update-eigenschappen van contract uitgeven.
Name | Type | Description |
---|---|---|
code |
string |
Laatste statuscode voor het synchroniseren en vernieuwen van het geheim uit de sleutelkluis. |
message |
string |
Details van de fout, anders leeg. |
timeStampUtc |
string |
De laatste keer dat het geheim is geopend. De datum voldoet aan de volgende notatie: |