Compartilhar via

Gateways Microsoft.ApiManagement 2023-09-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de gateways pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/gateways, adicione o Bicep a seguir ao modelo.

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 propriedade

ApiManagementGatewayProperties

Nome Descrição Valor
back-end Informações sobre como o gateway deve se integrar aos sistemas de back-end. BackendConfiguration
configurationApi Informações sobre a API de Configuração do gateway de Gerenciamento de API. Isso só é aplicável ao gateway de API com SKU Standard. GatewayConfigurationApi
front-end Informações sobre como o gateway deve ser exposto. FrontendConfiguration
virtualNetworkType O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado. 'Externo'
'Interno'
'None'

ApiManagementGatewaySkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas da SKU) int
nome Nome do Sku. 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obrigatório)

ApimResourceTags

Nome Descrição Valor

BackendConfiguration

Nome Descrição Valor
sub-rede O nome do host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas. BackendSubnetConfiguration

BackendSubnetConfiguration

Nome Descrição Valor
id A ID do ARM da sub-rede na qual os sistemas de back-end estão hospedados. corda

FrontendConfiguration

Nome Descrição Valor

GatewayConfigurationApi

Nome Descrição Valor

Microsoft.ApiManagement/gateways

Nome Descrição Valor
localização Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obrigatório)
Propriedades Propriedades do gateway de Gerenciamento de API. ApiManagementGatewayProperties (obrigatório)
Sku Propriedades de SKU do gateway de Gerenciamento de API. ApiManagementGatewaySkuProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

Definição de recurso de modelo do ARM

O tipo de recurso de gateways pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/gateways, adicione o JSON a seguir ao modelo.

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

ApiManagementGatewayProperties

Nome Descrição Valor
back-end Informações sobre como o gateway deve se integrar aos sistemas de back-end. BackendConfiguration
configurationApi Informações sobre a API de Configuração do gateway de Gerenciamento de API. Isso só é aplicável ao gateway de API com SKU Standard. GatewayConfigurationApi
front-end Informações sobre como o gateway deve ser exposto. FrontendConfiguration
virtualNetworkType O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado. 'Externo'
'Interno'
'None'

ApiManagementGatewaySkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas da SKU) int
nome Nome do Sku. 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obrigatório)

ApimResourceTags

Nome Descrição Valor

BackendConfiguration

Nome Descrição Valor
sub-rede O nome do host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas. BackendSubnetConfiguration

BackendSubnetConfiguration

Nome Descrição Valor
id A ID do ARM da sub-rede na qual os sistemas de back-end estão hospedados. corda

FrontendConfiguration

Nome Descrição Valor

GatewayConfigurationApi

Nome Descrição Valor

Microsoft.ApiManagement/gateways

Nome Descrição Valor
apiVersion A versão da API '2023-09-01-preview'
localização Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obrigatório)
Propriedades Propriedades do gateway de Gerenciamento de API. ApiManagementGatewayProperties (obrigatório)
Sku Propriedades de SKU do gateway de Gerenciamento de API. ApiManagementGatewaySkuProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.ApiManagement/gateways'

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de gateways pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/gateways, adicione o Terraform a seguir ao seu modelo.

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 propriedade

ApiManagementGatewayProperties

Nome Descrição Valor
back-end Informações sobre como o gateway deve se integrar aos sistemas de back-end. BackendConfiguration
configurationApi Informações sobre a API de Configuração do gateway de Gerenciamento de API. Isso só é aplicável ao gateway de API com SKU Standard. GatewayConfigurationApi
front-end Informações sobre como o gateway deve ser exposto. FrontendConfiguration
virtualNetworkType O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado. 'Externo'
'Interno'
'None'

ApiManagementGatewaySkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas da SKU) int
nome Nome do Sku. 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obrigatório)

ApimResourceTags

Nome Descrição Valor

BackendConfiguration

Nome Descrição Valor
sub-rede O nome do host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas. BackendSubnetConfiguration

BackendSubnetConfiguration

Nome Descrição Valor
id A ID do ARM da sub-rede na qual os sistemas de back-end estão hospedados. corda

FrontendConfiguration

Nome Descrição Valor

GatewayConfigurationApi

Nome Descrição Valor

Microsoft.ApiManagement/gateways

Nome Descrição Valor
localização Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obrigatório)
Propriedades Propriedades do gateway de Gerenciamento de API. ApiManagementGatewayProperties (obrigatório)
Sku Propriedades de SKU do gateway de Gerenciamento de API. ApiManagementGatewaySkuProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.ApiManagement/gateways@2023-09-01-preview"