Partilhar via

Gateways Microsoft.ApiManagement 2023-09-01-preview

  • Artigo

Definição de recursos do bíceps

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

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/gateways, adicione o seguinte Bicep ao seu 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

Designação 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 para gateway de API com SKU padrão. GatewayConfigurationApi
frontend Informações sobre a forma como o portal deve ser exposto. FrontendConfiguration
virtualNetworkType O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado. 'Externo'
'Interna'
'Nenhuma'

ApiManagementGatewaySkuProperties

Designação Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas do SKU) Int
Designação Nome do Sku. 'Padrão'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obrigatório)

ApimResourceTags

Designação Descrição Valor

BackendConfiguration

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

BackendSubnetConfiguration

Designação Descrição Valor
ID O ARM ID da sub-rede na qual os sistemas de back-end estão hospedados. string

FrontendConfiguration

Designação Descrição Valor

GatewayConfigurationApi

Designação Descrição Valor

Microsoft.ApiManagement/gateways

Designação Descrição Valor
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 45
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 SKU do gateway de Gerenciamento de API. ApiManagementGatewaySkuProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Definição de recurso de modelo ARM

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

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/gateways, adicione o seguinte JSON ao seu 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

Designação 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 para gateway de API com SKU padrão. GatewayConfigurationApi
frontend Informações sobre a forma como o portal deve ser exposto. FrontendConfiguration
virtualNetworkType O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado. 'Externo'
'Interna'
'Nenhuma'

ApiManagementGatewaySkuProperties

Designação Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas do SKU) Int
Designação Nome do Sku. 'Padrão'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obrigatório)

ApimResourceTags

Designação Descrição Valor

BackendConfiguration

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

BackendSubnetConfiguration

Designação Descrição Valor
ID O ARM ID da sub-rede na qual os sistemas de back-end estão hospedados. string

FrontendConfiguration

Designação Descrição Valor

GatewayConfigurationApi

Designação Descrição Valor

Microsoft.ApiManagement/gateways

Designação Descrição Valor
apiVersion A versão api '2023-09-01-pré-visualização'
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 45
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 SKU do gateway de Gerenciamento de API. ApiManagementGatewaySkuProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.ApiManagement/gateways'

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/gateways, adicione o seguinte Terraform 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

Designação 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 para gateway de API com SKU padrão. GatewayConfigurationApi
frontend Informações sobre a forma como o portal deve ser exposto. FrontendConfiguration
virtualNetworkType O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado. 'Externo'
'Interna'
'Nenhuma'

ApiManagementGatewaySkuProperties

Designação Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas do SKU) Int
Designação Nome do Sku. 'Padrão'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' (obrigatório)

ApimResourceTags

Designação Descrição Valor

BackendConfiguration

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

BackendSubnetConfiguration

Designação Descrição Valor
ID O ARM ID da sub-rede na qual os sistemas de back-end estão hospedados. string

FrontendConfiguration

Designação Descrição Valor

GatewayConfigurationApi

Designação Descrição Valor

Microsoft.ApiManagement/gateways

Designação Descrição Valor
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 45
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 SKU do gateway de Gerenciamento de API. ApiManagementGatewaySkuProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.ApiManagement/gateways@2023-09-01-preview"