Microsoft.ApiManagement/service 2016-10-10 - Bicep, ARM template & Terraform AzAPI reference

Definición de recursos de Bicep

El tipo de recurso de servicio se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

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, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

AdditionalRegion

Nombre	Descripción	Valor
ubicación	Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.	string (obligatorio)
skuType	Tipo de SKU en la ubicación.	'Developer' 'Premium' 'Estándar' (obligatorio)
skuUnitCount	Recuento de unidades de SKU en la ubicación. El número máximo de unidades de SKU depende del SkuType. El máximo permitido para la SKU para desarrolladores es 1, para la SKU estándar es 4 y para la SKU Premium es 10, en una ubicación.	Int Restricciones: Valor máximo = 10
vpnconfiguration	Configuración de red virtual para la ubicación.	virtualNetworkConfiguration

ApiManagementServiceProperties

Nombre	Descripción	Valor
additionalLocations	Ubicaciones adicionales del centro de datos del servicio API Management.	AdditionalRegion []
addresserEmail	Correo electrónico del direccionador.	cuerda
customProperties	Propiedades personalizadas del servicio API Management, como deshabilitar TLS 1.0.	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	Configuración de nombre de host personalizada del servicio API Management.	hostnameConfiguration[]
publisherEmail	Correo electrónico del publicador.	cuerda Restricciones: Longitud máxima = (obligatorio)
publisherName	Nombre del publicador.	string (obligatorio)
vpnconfiguration	Configuración de red virtual del servicio API Management.	virtualNetworkConfiguration
vpnType	Tipo de VPN en el que se debe configurar el servicio API Management. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna red virtual, external significa que la implementación de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde Internet y que la implementación interna de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde intranet solo.	'Externo' 'Interno' 'Ninguno'

ApiManagementServicePropertiesCustomProperties

Nombre	Descripción	Valor

ApiManagementServiceSkuProperties

Nombre	Descripción	Valor
capacidad	Capacidad de la SKU (número de unidades implementadas de la SKU). El valor predeterminado es 1.	Int
nombre	Nombre de la SKU.	'Developer' 'Premium' 'Estándar' (obligatorio)

CertificateInformation

Nombre	Descripción	Valor
expiración	Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.	string (obligatorio)
Asunto	Asunto del certificado.	string (obligatorio)
Huella digital	Huella digital del certificado.	string (obligatorio)

HostnameConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	certificateInformation (obligatorio)
nombre de host	Nombre de host.	string (obligatorio)
tipo	Tipo de nombre de host.	"Administración" 'Portal' 'Proxy' 'Scm' (obligatorio)

Microsoft.ApiManagement/service

Nombre	Descripción	Valor
ubicación	Ubicación del recurso.	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (obligatorio)
Propiedades	Propiedades del servicio API Management.	ApiManagementServiceProperties (obligatorio)
Sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

ResourceTags

Nombre	Descripción	Valor

VirtualNetworkConfiguration

Nombre	Descripción	Valor
ubicación	Ubicación de la red virtual.	cuerda
subnetResourceId	Identificador de recurso completo de una subred de una red virtual en la que se va a implementar el servicio API Management.	cuerda Restricciones: Patrón = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
Application Gateway con API Management interno y Web App	Application Gateway enruta el tráfico de Internet a una instancia de API Management de red virtual (modo interno) que proporciona servicios a una API web hospedada en una aplicación web de Azure.
Crear una instancia de API Management de nivel Premium de varias regiones	Esta plantilla muestra cómo crear una instancia de API Management con ubicaciones adicionales. La ubicación principal es la misma que la ubicación del grupo de recursos. En el caso de ubicaciones adicionales, la plantilla muestra NorthCentralUs y Este de EE. UU. 2. La ubicación principal debe ser diferente de otras.
Creación de una instancia de API Management con MSI Identity	Esta plantilla crea una instancia de desarrollador de Azure API Management que tiene una identidad MSI.
Crear una instancia de API Management mediante una plantilla	Esta plantilla crea una instancia de desarrollador de Azure API Management
Creación de un servicio API Management con un punto de conexión privado	Esta plantilla creará un servicio API Management, una red virtual y un punto de conexión privado que exponga el servicio API Management a la red virtual.
Creación de un servicio API Management con SSL desde KeyVault	Esta plantilla implementa un servicio de API Management configurado con identidad asignada por el usuario. Usa esta identidad para capturar el certificado SSL de KeyVault y lo mantiene actualizado comprobando cada 4 horas.
Creación de API Management en una red virtual interna con App Gateway	En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.
Implementación de API Management en una red virtual externa con ip pública	Esta plantilla muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo externo y configurar las reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Implementación de API Management en una red virtual interna con ip pública	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo interno y configurar reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Implementación de API Management en availability Zones	Esta plantilla crea una instancia premium de Azure API Management e implementa en una zona de disponibilidad.
Implementación de API Management con una instancia externa de Azure Cache for Redis	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel consumo con una instancia externa de Azure Cache for Redis como caché externa de API Management.
Front Door Standard/Premium con el origen de API Management	Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management y usa una directiva de NSG y API Management global para validar que el tráfico ha llegado a través del origen de Front Door.

Definición de recursos de plantilla de ARM

El tipo de recurso de servicio se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

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, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

AdditionalRegion

Nombre	Descripción	Valor
ubicación	Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.	string (obligatorio)
skuType	Tipo de SKU en la ubicación.	'Developer' 'Premium' 'Estándar' (obligatorio)
skuUnitCount	Recuento de unidades de SKU en la ubicación. El número máximo de unidades de SKU depende del SkuType. El máximo permitido para la SKU para desarrolladores es 1, para la SKU estándar es 4 y para la SKU Premium es 10, en una ubicación.	Int Restricciones: Valor máximo = 10
vpnconfiguration	Configuración de red virtual para la ubicación.	virtualNetworkConfiguration

ApiManagementServiceProperties

Nombre	Descripción	Valor
additionalLocations	Ubicaciones adicionales del centro de datos del servicio API Management.	AdditionalRegion []
addresserEmail	Correo electrónico del direccionador.	cuerda
customProperties	Propiedades personalizadas del servicio API Management, como deshabilitar TLS 1.0.	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	Configuración de nombre de host personalizada del servicio API Management.	hostnameConfiguration[]
publisherEmail	Correo electrónico del publicador.	cuerda Restricciones: Longitud máxima = (obligatorio)
publisherName	Nombre del publicador.	string (obligatorio)
vpnconfiguration	Configuración de red virtual del servicio API Management.	virtualNetworkConfiguration
vpnType	Tipo de VPN en el que se debe configurar el servicio API Management. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna red virtual, external significa que la implementación de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde Internet y que la implementación interna de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde intranet solo.	'Externo' 'Interno' 'Ninguno'

ApiManagementServicePropertiesCustomProperties

Nombre	Descripción	Valor

ApiManagementServiceSkuProperties

Nombre	Descripción	Valor
capacidad	Capacidad de la SKU (número de unidades implementadas de la SKU). El valor predeterminado es 1.	Int
nombre	Nombre de la SKU.	'Developer' 'Premium' 'Estándar' (obligatorio)

CertificateInformation

Nombre	Descripción	Valor
expiración	Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.	string (obligatorio)
Asunto	Asunto del certificado.	string (obligatorio)
Huella digital	Huella digital del certificado.	string (obligatorio)

HostnameConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	certificateInformation (obligatorio)
nombre de host	Nombre de host.	string (obligatorio)
tipo	Tipo de nombre de host.	"Administración" 'Portal' 'Proxy' 'Scm' (obligatorio)

Microsoft.ApiManagement/service

Nombre	Descripción	Valor
apiVersion	La versión de api	'2016-10-10'
ubicación	Ubicación del recurso.	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (obligatorio)
Propiedades	Propiedades del servicio API Management.	ApiManagementServiceProperties (obligatorio)
Sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.ApiManagement/service"

ResourceTags

Nombre	Descripción	Valor

VirtualNetworkConfiguration

Nombre	Descripción	Valor
ubicación	Ubicación de la red virtual.	cuerda
subnetResourceId	Identificador de recurso completo de una subred de una red virtual en la que se va a implementar el servicio API Management.	cuerda Restricciones: Patrón = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

Plantillas de inicio rápido

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

Plantilla	Descripción
Application Gateway con API Management interno y Web App	Application Gateway enruta el tráfico de Internet a una instancia de API Management de red virtual (modo interno) que proporciona servicios a una API web hospedada en una aplicación web de Azure.
Crear una instancia de API Management de nivel Premium de varias regiones	Esta plantilla muestra cómo crear una instancia de API Management con ubicaciones adicionales. La ubicación principal es la misma que la ubicación del grupo de recursos. En el caso de ubicaciones adicionales, la plantilla muestra NorthCentralUs y Este de EE. UU. 2. La ubicación principal debe ser diferente de otras.
Crear una instancia de API Management y todos los subrecursos mediante de plantilla	Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades
Creación de una instancia de API Management con MSI Identity	Esta plantilla crea una instancia de desarrollador de Azure API Management que tiene una identidad MSI.
Crear una instancia de API Management mediante una plantilla	Esta plantilla crea una instancia de desarrollador de Azure API Management
Creación de una instancia de API Management con nombres de host personalizados	En esta plantilla se muestra cómo crear una instancia de Azure API Management con un nombre de host personalizado para el portal y varios nombres de host personalizados para el proxy.
Creación de un servicio API Management con un punto de conexión privado	Esta plantilla creará un servicio API Management, una red virtual y un punto de conexión privado que exponga el servicio API Management a la red virtual.
Creación de un servicio API Management con SSL desde KeyVault	Esta plantilla implementa un servicio de API Management configurado con identidad asignada por el usuario. Usa esta identidad para capturar el certificado SSL de KeyVault y lo mantiene actualizado comprobando cada 4 horas.
Creación y supervisión de la instancia de API Management	Esta plantilla crea una instancia del servicio Azure API Management y el área de trabajo de Log Analytics y configura la supervisión del servicio API Management con Log Analytics.
Creación de API Management en una red virtual interna con App Gateway	En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.
Creación de API Management con ssl de proxy personalizado mediante KeyVault	En esta plantilla se muestra cómo crear una instancia de Azure API Management y configurar el nombre de host personalizado para el proxy con certificado ssl de keyvault.
Creación de Azure Front Door delante de Azure API Management	En este ejemplo se muestra cómo usar Azure Front Door como equilibrador de carga global delante de Azure API Management.
Implementación de API Management en una red virtual externa con ip pública	Esta plantilla muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo externo y configurar las reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Implementación de API Management en una red virtual interna con ip pública	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo interno y configurar reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Implementación de API Management en availability Zones	Esta plantilla crea una instancia premium de Azure API Management e implementa en una zona de disponibilidad.
Implementación de API Management con una instancia externa de Azure Cache for Redis	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel consumo con una instancia externa de Azure Cache for Redis como caché externa de API Management.
Front Door Standard/Premium con el origen de API Management	Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management y usa una directiva de NSG y API Management global para validar que el tráfico ha llegado a través del origen de Front Door.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso de servicio 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, agregue el siguiente Terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

Valores de propiedad

AdditionalRegion

Nombre	Descripción	Valor
ubicación	Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.	string (obligatorio)
skuType	Tipo de SKU en la ubicación.	'Developer' 'Premium' 'Estándar' (obligatorio)
skuUnitCount	Recuento de unidades de SKU en la ubicación. El número máximo de unidades de SKU depende del SkuType. El máximo permitido para la SKU para desarrolladores es 1, para la SKU estándar es 4 y para la SKU Premium es 10, en una ubicación.	Int Restricciones: Valor máximo = 10
vpnconfiguration	Configuración de red virtual para la ubicación.	virtualNetworkConfiguration

ApiManagementServiceProperties

Nombre	Descripción	Valor
additionalLocations	Ubicaciones adicionales del centro de datos del servicio API Management.	AdditionalRegion []
addresserEmail	Correo electrónico del direccionador.	cuerda
customProperties	Propiedades personalizadas del servicio API Management, como deshabilitar TLS 1.0.	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	Configuración de nombre de host personalizada del servicio API Management.	hostnameConfiguration[]
publisherEmail	Correo electrónico del publicador.	cuerda Restricciones: Longitud máxima = (obligatorio)
publisherName	Nombre del publicador.	string (obligatorio)
vpnconfiguration	Configuración de red virtual del servicio API Management.	virtualNetworkConfiguration
vpnType	Tipo de VPN en el que se debe configurar el servicio API Management. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna red virtual, external significa que la implementación de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde Internet y que la implementación interna de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde intranet solo.	'Externo' 'Interno' 'Ninguno'

ApiManagementServicePropertiesCustomProperties

Nombre	Descripción	Valor

ApiManagementServiceSkuProperties

Nombre	Descripción	Valor
capacidad	Capacidad de la SKU (número de unidades implementadas de la SKU). El valor predeterminado es 1.	Int
nombre	Nombre de la SKU.	'Developer' 'Premium' 'Estándar' (obligatorio)

CertificateInformation

Nombre	Descripción	Valor
expiración	Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.	string (obligatorio)
Asunto	Asunto del certificado.	string (obligatorio)
Huella digital	Huella digital del certificado.	string (obligatorio)

HostnameConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	certificateInformation (obligatorio)
nombre de host	Nombre de host.	string (obligatorio)
tipo	Tipo de nombre de host.	"Administración" 'Portal' 'Proxy' 'Scm' (obligatorio)

Microsoft.ApiManagement/service

Nombre	Descripción	Valor
ubicación	Ubicación del recurso.	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (obligatorio)
Propiedades	Propiedades del servicio API Management.	ApiManagementServiceProperties (obligatorio)
Sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.ApiManagement/service@2016-10-10"

ResourceTags

Nombre	Descripción	Valor

VirtualNetworkConfiguration

Nombre	Descripción	Valor
ubicación	Ubicación de la red virtual.	cuerda
subnetResourceId	Identificador de recurso completo de una subred de una red virtual en la que se va a implementar el servicio API Management.	cuerda Restricciones: Patrón = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

Compartir a través de

Servicio Microsoft.ApiManagement 2016-10-10

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

AdditionalRegion

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

ResourceTags

VirtualNetworkConfiguration

Ejemplos de inicio rápido

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

AdditionalRegion

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

ResourceTags

VirtualNetworkConfiguration

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

AdditionalRegion

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

ResourceTags

VirtualNetworkConfiguration

Comentarios

Recursos adicionales