Compartir a través de


Servicio Microsoft.ApiManagement/puertas de enlace

Definición de recursos de Bicep

El tipo de recurso service/gateways se puede implementar con operaciones que tienen como destino:

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

resource symbolicname 'Microsoft.ApiManagement/service/gateways@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

Valores de propiedad

service/gateways

Nombre Descripción Valor
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.
string (obligatorio)
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 la puerta de enlace. GatewayContractProperties

GatewayContractProperties

Nombre Descripción Valor
descripción Descripción de la puerta de enlace cuerda

Restricciones:
Longitud máxima = 1000
locationData Ubicación de la puerta de enlace. ResourceLocationDataContract

ResourceLocationDataContract

Nombre Descripción Valor
ciudad Ciudad o localidad donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
countryOrRegion País o región donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
distrito El distrito, el estado o la provincia donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
nombre Nombre canónico para la ubicación geográfica o física. string (obligatorio)

Restricciones:
Longitud máxima = 256

Plantillas de inicio rápido

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

Plantilla Descripción
Creación de API Management en una red virtual interna con App Gateway

Implementación en Azure
En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.

Definición de recursos de plantilla de ARM

El tipo de recurso service/gateways se puede implementar con operaciones que tienen como destino:

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

{
  "type": "Microsoft.ApiManagement/service/gateways",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "locationData": {
      "city": "string",
      "countryOrRegion": "string",
      "district": "string",
      "name": "string"
    }
  }
}

Valores de propiedad

service/gateways

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/gateways"
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)
Propiedades Detalles de la puerta de enlace. GatewayContractProperties

GatewayContractProperties

Nombre Descripción Valor
descripción Descripción de la puerta de enlace cuerda

Restricciones:
Longitud máxima = 1000
locationData Ubicación de la puerta de enlace. ResourceLocationDataContract

ResourceLocationDataContract

Nombre Descripción Valor
ciudad Ciudad o localidad donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
countryOrRegion País o región donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
distrito El distrito, el estado o la provincia donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
nombre Nombre canónico para la ubicación geográfica o física. string (obligatorio)

Restricciones:
Longitud máxima = 256

Plantillas de inicio rápido

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

Plantilla Descripción
Creación de API Management en una red virtual interna con App Gateway

Implementación en Azure
En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/gateways se puede implementar con operaciones que tienen como destino:

  • 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/gateways, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      locationData = {
        city = "string"
        countryOrRegion = "string"
        district = "string"
        name = "string"
      }
    }
  })
}

Valores de propiedad

service/gateways

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades Detalles de la puerta de enlace. GatewayContractProperties

GatewayContractProperties

Nombre Descripción Valor
descripción Descripción de la puerta de enlace cuerda

Restricciones:
Longitud máxima = 1000
locationData Ubicación de la puerta de enlace. ResourceLocationDataContract

ResourceLocationDataContract

Nombre Descripción Valor
ciudad Ciudad o localidad donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
countryOrRegion País o región donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
distrito El distrito, el estado o la provincia donde se encuentra el recurso. cuerda

Restricciones:
Longitud máxima = 256
nombre Nombre canónico para la ubicación geográfica o física. string (obligatorio)

Restricciones:
Longitud máxima = 256