Workspace Certificate - Create Or Update

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

Crea o aggiorna il certificato usato per l'autenticazione con il back-end.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}?api-version=2024-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificatore dell'entità certificato. Deve essere univoco nell'istanza corrente del servizio Gestione API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.data	string	Certificato codificato in base 64 usando la rappresentazione application/x-pkcs12.
properties.keyVault	KeyVaultContractCreateProperties	Dettagli del percorso dell'insieme di credenziali delle chiavi del certificato.
properties.password	string	Password per il certificato

Risposte

Nome	Tipo	Descrizione
200 OK	CertificateContract	I dettagli del certificato sono stati aggiornati correttamente. Intestazioni ETag: string
201 Created	CertificateContract	Il nuovo certificato è stato aggiunto correttamente. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

CertificateContract

I dettagli del certificato sono stati aggiornati correttamente.

Intestazioni

ETag: string

201 Created

CertificateContract

Il nuovo certificato è stato aggiunto 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

ApiManagementCreateWorkspaceCertificate

ApiManagementCreateWorkspaceCertificateWithKeyVault

ApiManagementCreateWorkspaceCertificate

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert?api-version=2024-05-01

{
  "properties": {
    "data": "****************Base 64 Encoded Certificate *******************************",
    "password": "****Certificate Password******"
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/workspaces/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/workspaces/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}

ApiManagementCreateWorkspaceCertificateWithKeyVault

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv?api-version=2024-05-01

{
  "properties": {
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert"
    }
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/workspaces/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"
      }
    }
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/workspaces/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.
CertificateCreateOrUpdateParameters	Dettagli sulla creazione o sull'aggiornamento del certificato.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
KeyVaultContractCreateProperties	Creare i dettagli del contratto keyVault.
KeyVaultContractProperties	Dettagli del contratto KeyVault.
KeyVaultLastAccessStatusContractProperties	Rilasciare le proprietà di aggiornamento del contratto.

CertificateContract

Object

Dettagli certificato.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.expirationDate	string (date-time)	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 oggetto del certificato.
properties.thumbprint	string	Identificazione personale del certificato.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

CertificateCreateOrUpdateParameters

Object

Dettagli sulla creazione o sull'aggiornamento del certificato.

Nome	Tipo	Descrizione
properties.data	string	Certificato codificato in base 64 usando la rappresentazione application/x-pkcs12.
properties.keyVault	KeyVaultContractCreateProperties	Dettagli del percorso dell'insieme di credenziali delle chiavi del certificato.
properties.password	string	Password per il certificato

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

KeyVaultContractCreateProperties

Object

Creare i 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.
secretIdentifier	string	Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi

KeyVaultContractProperties

Object

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	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 controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Object

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 else vuoto.
timeStampUtc	string (date-time)	Ultima volta a cui è stato eseguito l'accesso al segreto. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.

Condividi tramite

Workspace Certificate - Create Or Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreateWorkspaceCertificate

Esempio di richiesta

Risposta di esempio

ApiManagementCreateWorkspaceCertificateWithKeyVault

Esempio di richiesta

Risposta di esempio

Definizioni

CertificateContract

CertificateCreateOrUpdateParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

Risorse aggiuntive