Microsoft. Služba ApiManagement / certifikáty

Definice prostředku Bicep

Typ prostředku služby nebo certifikátů je možné nasadit do:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Vytvoření Microsoft. Prostředek ApiManagement/service/certificates, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2022-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

Hodnoty vlastností

služba/certifikáty

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.
string (povinné)

Omezení počtu znaků: 1–80

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu service
properties Podrobnosti o vytvoření nebo aktualizaci vlastností certifikátu CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Název Description Hodnota
data Certifikát s kódováním Base 64 pomocí reprezentace application/x-pkcs12. řetězec
trezor klíčů Podrobnosti o umístění certifikátu služby Key Vault KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
heslo Heslo pro certifikát řetězec

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Název Description Hodnota
id identityClientId Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. řetězec
secretIdentifier 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 řetězec

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

Nasazení do Azure
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.

Definice prostředku šablony ARM

Typ prostředku služby nebo certifikátů je možné nasadit do:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Vytvoření Microsoft. Prostředek ApiManagement/service/certificates, přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.ApiManagement/service/certificates",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "data": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "password": "string"
  }
}

Hodnoty vlastností

služba/certifikáty

Název Description Hodnota
typ Typ prostředku 'Microsoft. ApiManagement/služba/certifikáty'
apiVersion Verze rozhraní API prostředku 2022-04-01-preview
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.
string (povinné)

Omezení počtu znaků: 1–80

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.
properties Podrobnosti o vytvoření nebo aktualizaci vlastností certifikátu CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Název Description Hodnota
data Certifikát s kódováním Base 64 pomocí reprezentace application/x-pkcs12. řetězec
trezor klíčů Podrobnosti o umístění certifikátu služby Key Vault KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
heslo Heslo pro certifikát řetězec

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Název Description Hodnota
id identityClientId Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. řetězec
secretIdentifier 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 řetězec

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

Nasazení do Azure
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku služby nebo certifikátů je možné nasadit do:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Vytvoření Microsoft. Prostředek ApiManagement/service/certificates, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

Hodnoty vlastností

služba/certifikáty

Název Description Hodnota
typ Typ prostředku "Microsoft. ApiManagement/service/certificates@2022-04-01-preview"
name Název prostředku string (povinné)

Omezení počtu znaků: 1–80

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu service
properties Podrobnosti o vytvoření nebo aktualizaci vlastností certifikátu CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Název Description Hodnota
data Certifikát s kódováním Base 64 pomocí reprezentace application/x-pkcs12. řetězec
trezor klíčů Podrobnosti o umístění certifikátu služby Key Vault KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
heslo Heslo pro certifikát řetězec

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Název Description Hodnota
id identityClientId Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. řetězec
secretIdentifier 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 řetězec