Condividi tramite


Certificate - Refresh Secret

Da KeyVault aggiornare il certificato usato per l'autenticazione con il back-end.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret?api-version=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
certificateId
path True

string

Identificatore dell'entità certificato. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

Criterio di espressione regolare: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName
path True

string

Nome del servizio di Gestione API.

Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

CertificateContract

I dettagli del certificato sono stati aggiornati correttamente.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementRefreshCertificate

Esempio di richiesta

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv/refreshSecret?api-version=2022-08-01

Risposta di esempio

{
  "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"
      }
    }
  }
}

Definizioni

Nome Descrizione
CertificateContract

Dettagli certificato.

ErrorFieldContract

Contratto campo di errore.

ErrorResponse

Risposta errore.

KeyVaultContractProperties

Dettagli del contratto KeyVault.

KeyVaultLastAccessStatusContractProperties

Rilasciare le proprietà di aggiornamento del contratto.

CertificateContract

Dettagli certificato.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.expirationDate

string

Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.keyVault

KeyVaultContractProperties

Dettagli del percorso dell'insieme di credenziali delle chiavi del certificato.

properties.subject

string

Attributo soggetto del certificato.

properties.thumbprint

string

Identificazione personale del certificato.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Contratto campo di errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.

message

string

Rappresentazione leggibile dell'errore a livello di proprietà.

target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message

string

Rappresentazione leggibile dell'errore.

KeyVaultContractProperties

Dettagli del contratto KeyVault.

Nome Tipo Descrizione
identityClientId

string

Null per SystemAssignedIdentity o ID client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi.

lastStatus

KeyVaultLastAccessStatusContractProperties

Ora dell'ultima sincronizzazione e aggiornamento dello stato del segreto dall'insieme di credenziali delle chiavi.

secretIdentifier

string

Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con versione, si impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Rilasciare le proprietà di aggiornamento del contratto.

Nome Tipo Descrizione
code

string

Ultimo codice di stato per la sincronizzazione e l'aggiornamento del segreto dall'insieme di credenziali delle chiavi.

message

string

Dettagli dell'errore in caso contrario vuoto.

timeStampUtc

string

Ultima volta che è stato eseguito l'accesso al segreto. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.