Microsoft.ApiManagement service/certificates 2022-04-01-preview
Definice prostředku Bicep
Typ prostředku služby nebo certifikátů je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení 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
Pokud chcete vytvořit prostředek Microsoft.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 Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu. |
string (povinné) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi. |
| Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. 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 | Zakódovaný certifikát base 64 pomocí reprezentace application/x-pkcs12. | řetězec |
| keyVault | Podrobnosti o umístění certifikátu keyVault. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| heslo | Heslo k certifikátu | řetězec |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Název | Description | Hodnota |
|---|---|---|
| identityClientId | 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 klíče trezoru klíčů pro načtení tajného klíče 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 rychlého startu 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 |
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 s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení 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
Pokud chcete vytvořit prostředek Microsoft.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/service/certificates |
| apiVersion | Verze rozhraní API prostředků | '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é) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi. |
| properties | Podrobnosti o vytvoření nebo aktualizaci vlastností certifikátu | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Název | Description | Hodnota |
|---|---|---|
| data | Zakódovaný certifikát base 64 pomocí reprezentace application/x-pkcs12. | řetězec |
| keyVault | Podrobnosti o umístění certifikátu keyVault. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| heslo | Heslo k certifikátu | řetězec |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Název | Description | Hodnota |
|---|---|---|
| identityClientId | 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 klíče trezoru klíčů pro načtení tajného klíče 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 rychlého startu 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 |
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity. |
Definice prostředku Terraformu (zprostředkovatele AzAPI)
Typ prostředku služby nebo certifikátů je možné nasadit s operacemi, které cílí na:
- 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
Pokud chcete vytvořit prostředek Microsoft.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é) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi. |
| 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 | Zakódovaný certifikát base 64 pomocí reprezentace application/x-pkcs12. | řetězec |
| keyVault | Podrobnosti o umístění certifikátu keyVault. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| heslo | Heslo k certifikátu | řetězec |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Název | Description | Hodnota |
|---|---|---|
| identityClientId | 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 klíče trezoru klíčů pro načtení tajného klíče 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 |