Compartir a través de

Puertas de enlace de Microsoft.ApiManagement 2023-09-01-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso gateways 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/gateways, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/gateways@2023-09-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    backend: {
      subnet: {
        id: 'string'
      }
    }
    configurationApi: {}
    frontend: {}
    virtualNetworkType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

ApiManagementGatewayProperties

Nombre Descripción Valor
back-end Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end. backendConfiguration
configurationApi Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar. GatewayConfigurationApi
front-end Información sobre cómo se debe exponer la puerta de enlace. FrontendConfiguration
virtualNetworkType Tipo de VPN en el que se debe configurar API Management Gateway. 'Externo'
'Interno'
'Ninguno'

ApiManagementGatewaySkuProperties

Nombre Descripción Valor
capacidad Capacidad de la SKU (número de unidades implementadas de la SKU) Int
nombre Nombre de la SKU. 'Estándar'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obligatorio)

ApimResourceTags

Nombre Descripción Valor

BackendConfiguration

Nombre Descripción Valor
subred Nombre de host predeterminado de la puerta de enlace del plano de datos a la que se pueden enviar las solicitudes. backendSubnetConfiguration

BackendSubnetConfiguration

Nombre Descripción Valor
identificación Identificador de ARM de la subred en la que se hospedan los sistemas back-end. cuerda

FrontendConfiguration

Nombre Descripción Valor

GatewayConfigurationApi

Nombre Descripción Valor

Microsoft.ApiManagement/gateways

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 de la puerta de enlace de API Management. ApiManagementGatewayProperties (obligatorio)
Sku Propiedades de SKU de la puerta de enlace de API Management. ApiManagementGatewaySkuProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

Definición de recursos de plantilla de ARM

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

{
  "type": "Microsoft.ApiManagement/gateways",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "backend": {
      "subnet": {
        "id": "string"
      }
    },
    "configurationApi": {
    },
    "frontend": {
    },
    "virtualNetworkType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

ApiManagementGatewayProperties

Nombre Descripción Valor
back-end Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end. backendConfiguration
configurationApi Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar. GatewayConfigurationApi
front-end Información sobre cómo se debe exponer la puerta de enlace. FrontendConfiguration
virtualNetworkType Tipo de VPN en el que se debe configurar API Management Gateway. 'Externo'
'Interno'
'Ninguno'

ApiManagementGatewaySkuProperties

Nombre Descripción Valor
capacidad Capacidad de la SKU (número de unidades implementadas de la SKU) Int
nombre Nombre de la SKU. 'Estándar'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obligatorio)

ApimResourceTags

Nombre Descripción Valor

BackendConfiguration

Nombre Descripción Valor
subred Nombre de host predeterminado de la puerta de enlace del plano de datos a la que se pueden enviar las solicitudes. backendSubnetConfiguration

BackendSubnetConfiguration

Nombre Descripción Valor
identificación Identificador de ARM de la subred en la que se hospedan los sistemas back-end. cuerda

FrontendConfiguration

Nombre Descripción Valor

GatewayConfigurationApi

Nombre Descripción Valor

Microsoft.ApiManagement/gateways

Nombre Descripción Valor
apiVersion La versión de api '2023-09-01-preview'
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 de la puerta de enlace de API Management. ApiManagementGatewayProperties (obligatorio)
Sku Propiedades de SKU de la puerta de enlace de API Management. ApiManagementGatewaySkuProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso "Microsoft.ApiManagement/gateways"

Definición de recursos de Terraform (proveedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/gateways@2023-09-01-preview"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      backend = {
        subnet = {
          id = "string"
        }
      }
      configurationApi = {
      }
      frontend = {
      }
      virtualNetworkType = "string"
    }
  })
}

Valores de propiedad

ApiManagementGatewayProperties

Nombre Descripción Valor
back-end Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end. backendConfiguration
configurationApi Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar. GatewayConfigurationApi
front-end Información sobre cómo se debe exponer la puerta de enlace. FrontendConfiguration
virtualNetworkType Tipo de VPN en el que se debe configurar API Management Gateway. 'Externo'
'Interno'
'Ninguno'

ApiManagementGatewaySkuProperties

Nombre Descripción Valor
capacidad Capacidad de la SKU (número de unidades implementadas de la SKU) Int
nombre Nombre de la SKU. 'Estándar'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obligatorio)

ApimResourceTags

Nombre Descripción Valor

BackendConfiguration

Nombre Descripción Valor
subred Nombre de host predeterminado de la puerta de enlace del plano de datos a la que se pueden enviar las solicitudes. backendSubnetConfiguration

BackendSubnetConfiguration

Nombre Descripción Valor
identificación Identificador de ARM de la subred en la que se hospedan los sistemas back-end. cuerda

FrontendConfiguration

Nombre Descripción Valor

GatewayConfigurationApi

Nombre Descripción Valor

Microsoft.ApiManagement/gateways

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 de la puerta de enlace de API Management. ApiManagementGatewayProperties (obligatorio)
Sku Propiedades de SKU de la puerta de enlace de API Management. ApiManagementGatewaySkuProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.ApiManagement/gateways@2023-09-01-preview"