Certificate - Create Or Update

Reference

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Vytvoří nebo aktualizuje certifikát používaný k ověřování pomocí back-endu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identifikátor entity certifikátu. V aktuální instanci služby API Management musí být jedinečné.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	ETag of the Entity. Při vytváření entity se nevyžaduje, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name	Typ	Description
properties.data	string	Základní 64 kódovaný certifikát pomocí reprezentace application/x-pkcs12
properties.keyVault	KeyVaultContractCreateProperties	Podrobnosti o umístění služby KeyVault certifikátu
properties.password	string	Heslo pro certifikát

Odpovědi

Name	Typ	Description
200 OK	CertificateContract	Podrobnosti o certifikátu byly úspěšně aktualizovány. Hlavičky ETag: string
201 Created	CertificateContract	Nový certifikát byl úspěšně přidán. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

CertificateContract

Podrobnosti o certifikátu byly úspěšně aktualizovány.

Hlavičky

ETag: string

201 Created

CertificateContract

Nový certifikát byl úspěšně přidán.

Hlavičky

ETag: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

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

ApiManagementCreateCertificate

ApiManagementCreateCertificateWithKeyVault

ApiManagementCreateCertificate

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 201

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

Stavový kód:: 200

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

ApiManagementCreateCertificateWithKeyVault

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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"
    }
  }
}

Ukázková odpověď

Stavový kód:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
      }
    }
  }
}

Stavový kód:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
CertificateContract	Podrobnosti o certifikátu
CertificateCreateOrUpdateParameters	Vytvoření nebo aktualizace certifikátu
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
KeyVaultContractCreateProperties	Vytvoření podrobností kontraktu keyVault
KeyVaultContractProperties	Podrobnosti kontraktu služby KeyVault
KeyVaultLastAccessStatusContractProperties	Vydání kontraktu – vlastnosti aktualizace

CertificateContract

Objekt

Podrobnosti o certifikátu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.expirationDate	string (date-time)	Datum vypršení platnosti certifikátu Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.keyVault	KeyVaultContractProperties	Podrobnosti o umístění služby KeyVault certifikátu
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

CertificateCreateOrUpdateParameters

Objekt

Vytvoření nebo aktualizace certifikátu

Name	Typ	Description
properties.data	string	Základní 64 kódovaný certifikát pomocí reprezentace application/x-pkcs12
properties.keyVault	KeyVaultContractCreateProperties	Podrobnosti o umístění služby KeyVault certifikátu
properties.password	string	Heslo pro certifikát

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

KeyVaultContractCreateProperties

Objekt

Vytvoření podrobností kontraktu keyVault

Name	Typ	Description
identityClientId	string	Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů.
secretIdentifier	string	Identifikátor tajného klíče trezoru klíčů pro načtení tajného kódu 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

KeyVaultContractProperties

Objekt

Podrobnosti kontraktu služby KeyVault

Name	Typ	Description
identityClientId	string	Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů.
lastStatus	KeyVaultLastAccessStatusContractProperties	Čas poslední synchronizace a aktualizace stavu tajného kódu z trezoru klíčů
secretIdentifier	string	Identifikátor tajného klíče trezoru klíčů pro načtení tajného kódu 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

Objekt

Vydání kontraktu – vlastnosti aktualizace

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ě, která je prázdná
timeStampUtc	string (date-time)	Při posledním přístupu k tajnému kódu došlo k tajnému kódu. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.

Sdílet prostřednictvím

Certificate - Create Or Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementCreateCertificate

Ukázkový požadavek

Ukázková odpověď

ApiManagementCreateCertificateWithKeyVault

Ukázkový požadavek

Ukázková odpověď

Definice

CertificateContract

CertificateCreateOrUpdateParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

Další materiály