Compartir a través de


Servicio Microsoft.ApiManagement/certificados

Definición de recursos de Bicep

El tipo de recurso service/certificates se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/certificates, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-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 Valor
nombre 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 la letra y termine con alfanumérico.
padre 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 obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: de servicio de
Propiedades 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. cuerda
keyVault Detalles de ubicación de KeyVault del certificado. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
contraseña Contraseña del certificado cuerda

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. cuerda
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 el servicio API Management se configure con aka.ms/apimmsi cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Crear una instancia de API Management y todos los subrecursos mediante de plantilla

Implementación en Azure
Esta plantilla 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:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/certificates, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

service/certificates

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/certificates"
apiVersion La versión de la API de recursos '2023-09-01-preview'
nombre El nombre del recurso

Vea 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 la letra y termine con alfanumérico.
Propiedades 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. cuerda
keyVault Detalles de ubicación de KeyVault del certificado. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
contraseña Contraseña del certificado cuerda

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. cuerda
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 el servicio API Management se configure con aka.ms/apimmsi cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Crear una instancia de API Management y todos los subrecursos mediante de plantilla

Implementación en Azure
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 de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/certificates, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2023-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 Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/certificates@2023-09-01-preview"
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con la letra y termine con alfanumérico.
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades 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. cuerda
keyVault Detalles de ubicación de KeyVault del certificado. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
contraseña Contraseña del certificado cuerda

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. cuerda
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 el servicio API Management se configure con aka.ms/apimmsi cuerda