Servicio Microsoft.ApiManagement/gateways 2023-03-01-preview
Definición de recursos de Bicep
El tipo de recurso service/gateways se puede implementar con operaciones que tienen como destino:
- 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/gateways, agregue lo siguiente a la plantilla de Bicep.
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2023-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
Valores de propiedad
GatewayContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la puerta de enlace | cuerda Restricciones: Longitud máxima = |
| locationData | Ubicación de la puerta de enlace. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (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 |
ResourceLocationDataContract
| Nombre | Descripción | Valor |
|---|---|---|
| ciudad | Ciudad o localidad donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| countryOrRegion | País o región donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| distrito | El distrito, el estado o la provincia donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| nombre | Nombre canónico para la ubicación geográfica o física. | cuerda Restricciones: Longitud máxima = (obligatorio) |
Ejemplos de inicio rápido
En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.
| Archivo de Bicep | Descripción |
|---|---|
| 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. |
Definición de recursos de plantilla de ARM
El tipo de recurso service/gateways se puede implementar con operaciones que tienen como destino:
- 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/gateways, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
Valores de propiedad
GatewayContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la puerta de enlace | cuerda Restricciones: Longitud máxima = |
| locationData | Ubicación de la puerta de enlace. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2023-03-01-preview' |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
| Propiedades | Detalles de la puerta de enlace. | GatewayContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/gateways" |
ResourceLocationDataContract
| Nombre | Descripción | Valor |
|---|---|---|
| ciudad | Ciudad o localidad donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| countryOrRegion | País o región donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| distrito | El distrito, el estado o la provincia donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| nombre | Nombre canónico para la ubicación geográfica o física. | cuerda Restricciones: Longitud máxima = (obligatorio) |
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
|
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-03-01-preview"
name = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
Valores de propiedad
GatewayContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la puerta de enlace | cuerda Restricciones: Longitud máxima = |
| locationData | Ubicación de la puerta de enlace. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (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 |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/gateways@2023-03-01-preview" |
ResourceLocationDataContract
| Nombre | Descripción | Valor |
|---|---|---|
| ciudad | Ciudad o localidad donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| countryOrRegion | País o región donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| distrito | El distrito, el estado o la provincia donde se encuentra el recurso. | cuerda Restricciones: Longitud máxima = |
| nombre | Nombre canónico para la ubicación geográfica o física. | cuerda Restricciones: Longitud máxima = (obligatorio) |