Servicio Microsoft.ApiManagement/certificates 2022-09-01-preview
Definición de recursos de Bicep
El tipo de recurso service/certificates se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/certificates, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2022-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Valores de propiedad
service/certificates
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| primario | En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: servicio |
| properties | Detalles de creación o actualización de propiedades de certificado. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nombre | Descripción | Valor |
|---|---|---|
| datos | Certificado codificado en base 64 mediante la representación application/x-pkcs12. | string |
| keyVault | Detalles de ubicación de KeyVault del certificado. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | Contraseña del certificado | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nombre | Descripción | Valor |
|---|---|---|
| identityClientId | Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity, que se usará para acceder al secreto del almacén de claves. | string |
| secretIdentifier | Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi | string |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla |
En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades. |
Definición de recursos de plantilla de ARM
El tipo de recurso service/certificates se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/certificates, agregue el siguiente json a la plantilla.
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2022-09-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
Valores de propiedad
service/certificates
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/certificates" |
| apiVersion | La versión de la API de recursos | "2022-09-01-preview" |
| name | El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| properties | Detalles de creación o actualización de propiedades de certificado. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nombre | Descripción | Valor |
|---|---|---|
| datos | Certificado codificado en base 64 mediante la representación application/x-pkcs12. | string |
| keyVault | Detalles de ubicación de KeyVault del certificado. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | Contraseña del certificado | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nombre | Descripción | Valor |
|---|---|---|
| identityClientId | Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity , que se usará para acceder al secreto del almacén de claves. | string |
| secretIdentifier | Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi | string |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
| Creación de una instancia de API Management y todos los subrecursos mediante la plantilla |
Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/certificates se puede implementar con operaciones destinadas a:
- Grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/certificates, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/certificates@2022-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
Valores de propiedad
service/certificates
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/certificates@2022-09-01-preview" |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: servicio |
| properties | Detalles de creación o actualización de propiedades de certificado. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nombre | Descripción | Valor |
|---|---|---|
| datos | Certificado codificado en base 64 mediante la representación application/x-pkcs12. | string |
| keyVault | Detalles de ubicación de KeyVault del certificado. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | Contraseña del certificado | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nombre | Descripción | Valor |
|---|---|---|
| identityClientId | Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity , que se usará para acceder al secreto del almacén de claves. | string |
| secretIdentifier | Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi | string |