Microsoft.ApiManagement-tjänst/certifikat
Bicep-resursdefinition
Resurstypen tjänst/certifikat kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/certificates-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Egenskapsvärden
tjänst/certifikat
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: tjänst |
| properties | Information om att skapa eller uppdatera egenskaper för certifikat. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Name | Beskrivning | Värde |
|---|---|---|
| data | Base 64-kodat certifikat med hjälp av representationen application/x-pkcs12. | sträng |
| keyVault | KeyVault-platsinformation för certifikatet. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | Lösenord för certifikatet | sträng |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som används för att komma åt key vault-hemlighet. | sträng |
| secretIdentifier | Key Vault-hemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindras automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Description |
|---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för ARM-mall
Resurstypen tjänst/certifikat kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/certificates lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
Egenskapsvärden
tjänst/certifikat
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/certificates" |
| apiVersion | Resurs-API-versionen | "2023-05-01-preview" |
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| properties | Information om att skapa eller uppdatera egenskaper för certifikat. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Name | Beskrivning | Värde |
|---|---|---|
| data | Base 64-kodat certifikat med hjälp av representationen application/x-pkcs12. | sträng |
| keyVault | KeyVault-platsinformation för certifikatet. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | Lösenord för certifikatet | sträng |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som används för att komma åt key vault-hemlighet. | sträng |
| secretIdentifier | Key Vault-hemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindras automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Description |
|---|---|
| Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/certifikat kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/certificates lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/certificates@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
Egenskapsvärden
tjänst/certifikat
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/certificates@2023-05-01-preview" |
| name | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| properties | Information om att skapa eller uppdatera egenskaper för certifikat. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Name | Beskrivning | Värde |
|---|---|---|
| data | Base 64-kodat certifikat med hjälp av representationen application/x-pkcs12. | sträng |
| keyVault | KeyVault-platsinformation för certifikatet. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | Lösenord för certifikatet | sträng |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som används för att komma åt key vault-hemlighet. | sträng |
| secretIdentifier | Key Vault-hemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindras automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för