Sdílet prostřednictvím


Certificate - Create Or Update

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=2022-08-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
certificateId
path True

string

Identifikátor entity certifikátu. Musí být jedinečný v aktuální instanci služby API Management.

Vzor regulárního výrazu: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName
path True

string

Název služby API Management.

Vzor regulárního výrazu: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
If-Match

string

Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name Typ Description
properties.data

string

Certifikát s kódováním Base 64 pomocí reprezentace application/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

Podrobnosti o umístění certifikátu služby Key Vault

properties.password

string

Heslo pro certifikát

Odpovědi

Name Typ Description
200 OK

CertificateContract

Podrobnosti o certifikátu se úspěšně aktualizovaly.

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 Azure Active Directory OAuth2.

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

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
CertificateContract

Podrobnosti o certifikátu.

CertificateCreateOrUpdateParameters

Podrobnosti o vytvoření nebo aktualizaci certifikátu

ErrorFieldContract

Chybový kontrakt pole.

ErrorResponse

Odpověď na chybu.

KeyVaultContractCreateProperties

Vytvoření podrobností o smlouvě keyVault

KeyVaultContractProperties

Podrobnosti o kontraktu služby KeyVault

KeyVaultLastAccessStatusContractProperties

Aktualizace vlastností smlouvy o vydání.

CertificateContract

Podrobnosti o certifikátu.

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}

name

string

Název prostředku

properties.expirationDate

string

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í certifikátu služby Key Vault

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

Podrobnosti o vytvoření nebo aktualizaci certifikátu

Name Typ Description
properties.data

string

Certifikát s kódováním Base 64 pomocí reprezentace application/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

Podrobnosti o umístění certifikátu služby Key Vault

properties.password

string

Heslo pro certifikát

ErrorFieldContract

Chybový kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.

message

string

Pro člověka čitelná reprezentace chyby na úrovni vlastností.

target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v požadavku v případě chyby ověření.

error.message

string

Pro člověka čitelná reprezentace chyby.

KeyVaultContractCreateProperties

Vytvoření podrobností o smlouvě 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 kódu 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

Podrobnosti o 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 stav aktualizace tajného kódu z trezoru klíčů

secretIdentifier

string

Identifikátor tajného kódu 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

Aktualizace vlastností smlouvy o vydání.

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ě jsou prázdné.

timeStampUtc

string

Čas posledního přístupu k tajnému kódu Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.