Serviço/gateways Microsoft.ApiManagement
Definição de recursos do bíceps
O tipo de recurso de serviço/gateways pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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/service/gateways, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
Valores de propriedade
GatewayContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| Descrição | Descrição do gateway | string Restrições: Comprimento máximo = 1000 |
| locationData | Localização do gateway. | ResourceLocationDataContract |
Microsoft.ApiManagement/serviço/gateways
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico para recurso do tipo: serviço |
| propriedades | Detalhes do gateway. | GatewayContractProperties |
ResourceLocationDataContract
| Designação | Descrição | Valor |
|---|---|---|
| cidade | A cidade ou localidade onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| paísOrRegião | O país ou região onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| Distrito | O distrito, estado ou província onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| Designação | Um nome canônico para a localização geográfica ou física. | string Restrições: Comprimento máximo = 256 (obrigatório) |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Criar gerenciamento de API em rede virtual interna com do App Gateway | Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure. |
Definição de recurso de modelo ARM
O tipo de recurso de serviço/gateways pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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/service/gateways, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
Valores de propriedade
GatewayContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| Descrição | Descrição do gateway | string Restrições: Comprimento máximo = 1000 |
| locationData | Localização do gateway. | ResourceLocationDataContract |
Microsoft.ApiManagement/serviço/gateways
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2024-06-01-pré-visualização' |
| Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório) |
| propriedades | Detalhes do gateway. | GatewayContractProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/gateways' |
ResourceLocationDataContract
| Designação | Descrição | Valor |
|---|---|---|
| cidade | A cidade ou localidade onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| paísOrRegião | O país ou região onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| Distrito | O distrito, estado ou província onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| Designação | Um nome canônico para a localização geográfica ou física. | string Restrições: Comprimento máximo = 256 (obrigatório) |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Criar gerenciamento de API em rede virtual interna com do App Gateway
|
Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso de serviço/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/service/gateways, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/gateways@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
Valores de propriedade
GatewayContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| Descrição | Descrição do gateway | string Restrições: Comprimento máximo = 1000 |
| locationData | Localização do gateway. | ResourceLocationDataContract |
Microsoft.ApiManagement/serviço/gateways
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 80 (obrigatório) |
| parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
| propriedades | Detalhes do gateway. | GatewayContractProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/gateways@2024-06-01-preview" |
ResourceLocationDataContract
| Designação | Descrição | Valor |
|---|---|---|
| cidade | A cidade ou localidade onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| paísOrRegião | O país ou região onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| Distrito | O distrito, estado ou província onde o recurso está localizado. | string Restrições: Comprimento máximo = 256 |
| Designação | Um nome canônico para a localização geográfica ou física. | string Restrições: Comprimento máximo = 256 (obrigatório) |