Megosztás a következőn keresztül:


Certificate - Create Or Update

Létrehozza vagy frissíti a háttérrendszerrel való hitelesítéshez használt tanúsítványt.

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

URI-paraméterek

Name In Kötelező Típus Description
certificateId
path True

string

A tanúsítványentitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

Reguláris kifejezési minta: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

serviceName
path True

string

A API Management szolgáltatás neve.

Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A cél-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

Az entitás ETagje. Entitás létrehozásakor nem kötelező, de az entitások frissítésekor kötelező.

Kérelem törzse

Name Típus Description
properties.data

string

Base 64 kódolású tanúsítvány az alkalmazás/x-pkcs12 reprezentáció használatával.

properties.keyVault

KeyVaultContractCreateProperties

A tanúsítvány KeyVault-helyadatai.

properties.password

string

A tanúsítvány jelszava

Válaszok

Name Típus Description
200 OK

CertificateContract

A tanúsítvány részletei sikeresen frissültek.

Fejlécek

ETag: string

201 Created

CertificateContract

Az új tanúsítvány hozzáadása sikerült.

Fejlécek

ETag: string

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

ApiManagementCreateCertificate
ApiManagementCreateCertificateWithKeyVault

ApiManagementCreateCertificate

Mintakérelem

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

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

Mintaválasz

{
  "id": "/subscriptions/subid/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"
  }
}
{
  "id": "/subscriptions/subid/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

Mintakérelem

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

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

Mintaválasz

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

Definíciók

Name Description
CertificateContract

Tanúsítvány részletei.

CertificateCreateOrUpdateParameters

A tanúsítvány létrehozásának vagy frissítésének részletei.

ErrorFieldContract

Hibamező-szerződés.

ErrorResponse

Hibaválasz.

KeyVaultContractCreateProperties

Hozza létre a keyVault szerződés részleteit.

KeyVaultContractProperties

KeyVault-szerződés részletei.

KeyVaultLastAccessStatusContractProperties

Szerződés frissítési tulajdonságainak kiállítása.

CertificateContract

Tanúsítvány részletei.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Az erőforrás neve

properties.expirationDate

string

A tanúsítvány lejárati dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.keyVault

KeyVaultContractProperties

A tanúsítvány KeyVault-helyadatai.

properties.subject

string

A tanúsítvány tulajdonosattribútuma.

properties.thumbprint

string

A tanúsítványhoz tartozó ujjlenyomat.

type

string

Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

CertificateCreateOrUpdateParameters

A tanúsítvány létrehozásának vagy frissítésének részletei.

Name Típus Description
properties.data

string

Base 64 kódolású tanúsítvány az alkalmazás/x-pkcs12 reprezentáció használatával.

properties.keyVault

KeyVaultContractCreateProperties

A tanúsítvány KeyVault-helyadatai.

properties.password

string

A tanúsítvány jelszava

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.

message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.

error.details

ErrorFieldContract[]

Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája.

error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

KeyVaultContractCreateProperties

Hozza létre a keyVault szerződés részleteit.

Name Típus Description
identityClientId

string

Null érték a SystemAssignedIdentity vagy a UserAssignedIdentity ügyfél-azonosítója esetében, amely a Key Vault titkos kulcsainak eléréséhez lesz használva.

secretIdentifier

string

Titkos kulcstartó-azonosító a titkos kód lekéréséhez. A verziószámozott titkos kód megadása megakadályozza az automatikus frissítést. Ehhez API Management szolgáltatást kell konfigurálni aka.ms/apimmsi

KeyVaultContractProperties

KeyVault-szerződés részletei.

Name Típus Description
identityClientId

string

Null érték a SystemAssignedIdentity vagy a UserAssignedIdentity ügyfél-azonosítója esetében, amely a Key Vault titkos kulcsainak eléréséhez lesz használva.

lastStatus

KeyVaultLastAccessStatusContractProperties

A key vault titkos kulcsának legutóbbi szinkronizálási és frissítési állapota.

secretIdentifier

string

Titkos kulcstartó-azonosító a titkos kód lekéréséhez. A verziószámozott titkos kód megadása megakadályozza az automatikus frissítést. Ehhez API Management szolgáltatást kell konfigurálni aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Szerződés frissítési tulajdonságainak kiállítása.

Name Típus Description
code

string

Utolsó állapotkód a key vault titkos kódjának szinkronizálásához és frissítéséhez.

message

string

A hiba részletei üresek.

timeStampUtc

string

A titkos kód legutóbbi elérésének időpontja. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.