Condividi tramite

Gateway Microsoft.ApiManagement 2023-09-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa gateway può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/gateways, aggiungere il bicep seguente al modello.

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'
  }
}

Valori delle proprietà

ApiManagementGatewayProperties

Nome Descrizione Valore
back-end Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end. BackendConfiguration
configurationApi Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard. GatewayConfigurationApi
front-end Informazioni sulla modalità di esposizione del gateway. FrontendConfiguration
virtualNetworkType Tipo di VPN in cui deve essere configurato il gateway di Gestione API. 'External'
'Interno'
'Nessuno'

ApiManagementGatewaySkuProperties

Nome Descrizione Valore
capacità Capacità dello SKU (numero di unità distribuite dello SKU) Int
nome Nome dello SKU. 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obbligatorio)

ApimResourceTags

Nome Descrizione Valore

BackendConfiguration

Nome Descrizione Valore
sottorete Nome host predefinito del gateway del piano dati a cui è possibile inviare le richieste. BackendSubnetConfiguration

BackendSubnetConfiguration

Nome Descrizione Valore
Id ID ARM della subnet in cui sono ospitati i sistemi back-end. corda

FrontendConfiguration

Nome Descrizione Valore

GatewayConfigurationApi

Nome Descrizione Valore

Microsoft.ApiManagement/gateways

Nome Descrizione Valore
ubicazione Percorso della risorsa. stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obbligatorio)
proprietà Proprietà del gateway di Gestione API. ApiManagementGatewayProperties (obbligatorio)
Sku Proprietà SKU del gateway di Gestione API. ApiManagementGatewaySkuProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa gateway può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/gateways, aggiungere il codice JSON seguente al modello.

{
  "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"
  }
}

Valori delle proprietà

ApiManagementGatewayProperties

Nome Descrizione Valore
back-end Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end. BackendConfiguration
configurationApi Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard. GatewayConfigurationApi
front-end Informazioni sulla modalità di esposizione del gateway. FrontendConfiguration
virtualNetworkType Tipo di VPN in cui deve essere configurato il gateway di Gestione API. 'External'
'Interno'
'Nessuno'

ApiManagementGatewaySkuProperties

Nome Descrizione Valore
capacità Capacità dello SKU (numero di unità distribuite dello SKU) Int
nome Nome dello SKU. 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obbligatorio)

ApimResourceTags

Nome Descrizione Valore

BackendConfiguration

Nome Descrizione Valore
sottorete Nome host predefinito del gateway del piano dati a cui è possibile inviare le richieste. BackendSubnetConfiguration

BackendSubnetConfiguration

Nome Descrizione Valore
Id ID ARM della subnet in cui sono ospitati i sistemi back-end. corda

FrontendConfiguration

Nome Descrizione Valore

GatewayConfigurationApi

Nome Descrizione Valore

Microsoft.ApiManagement/gateways

Nome Descrizione Valore
apiVersion Versione dell'API '2023-09-01-preview'
ubicazione Percorso della risorsa. stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obbligatorio)
proprietà Proprietà del gateway di Gestione API. ApiManagementGatewayProperties (obbligatorio)
Sku Proprietà SKU del gateway di Gestione API. ApiManagementGatewaySkuProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.ApiManagement/gateways'

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa gateway può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/gateways, aggiungere il codice Terraform seguente al modello.

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"
    }
  })
}

Valori delle proprietà

ApiManagementGatewayProperties

Nome Descrizione Valore
back-end Informazioni sul modo in cui il gateway deve integrarsi con i sistemi back-end. BackendConfiguration
configurationApi Informazioni sull'API di configurazione del gateway di Gestione API. Questo è applicabile solo per il gateway API con SKU Standard. GatewayConfigurationApi
front-end Informazioni sulla modalità di esposizione del gateway. FrontendConfiguration
virtualNetworkType Tipo di VPN in cui deve essere configurato il gateway di Gestione API. 'External'
'Interno'
'Nessuno'

ApiManagementGatewaySkuProperties

Nome Descrizione Valore
capacità Capacità dello SKU (numero di unità distribuite dello SKU) Int
nome Nome dello SKU. 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obbligatorio)

ApimResourceTags

Nome Descrizione Valore

BackendConfiguration

Nome Descrizione Valore
sottorete Nome host predefinito del gateway del piano dati a cui è possibile inviare le richieste. BackendSubnetConfiguration

BackendSubnetConfiguration

Nome Descrizione Valore
Id ID ARM della subnet in cui sono ospitati i sistemi back-end. corda

FrontendConfiguration

Nome Descrizione Valore

GatewayConfigurationApi

Nome Descrizione Valore

Microsoft.ApiManagement/gateways

Nome Descrizione Valore
ubicazione Percorso della risorsa. stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obbligatorio)
proprietà Proprietà del gateway di Gestione API. ApiManagementGatewayProperties (obbligatorio)
Sku Proprietà SKU del gateway di Gestione API. ApiManagementGatewaySkuProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.ApiManagement/gateways@2023-09-01-preview"