你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/gateways 2022-08-01
Bicep 资源定义
可以使用针对以下操作部署服务/网关资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/gateways 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
属性值
service/gateways
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为“服务”的资源的符号名称 |
| properties | 网关详细信息。 | GatewayContractProperties |
GatewayContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| description | 网关说明 | 字符串 |
| locationData | 网关位置。 | ResourceLocationDataContract |
ResourceLocationDataContract
| 名称 | 说明 | 值 |
|---|---|---|
| city | 资源所在的城市或位置。 | 字符串 |
| countryOrRegion | 资源所在的国家或地区。 | 字符串 |
| 地区 | 资源所在的地区、州或省/自治区。 | 字符串 |
| name | 地理或物理位置的规范名称。 | 字符串 (必需) |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
使用应用网关在内部 VNet 中创建API 管理 |
此模板演示如何在受Azure 应用程序网关保护的专用网络上创建 Azure API 管理 实例。 |
ARM 模板资源定义
可以使用针对以下操作部署服务/网关资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/gateways 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
属性值
service/gateways
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/gateways” |
| apiVersion | 资源 API 版本 | '2022-08-01' |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) |
| properties | 网关详细信息。 | GatewayContractProperties |
GatewayContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| description | 网关说明 | 字符串 |
| locationData | 网关位置。 | ResourceLocationDataContract |
ResourceLocationDataContract
| 名称 | 说明 | 值 |
|---|---|---|
| city | 资源所在的城市或位置。 | 字符串 |
| countryOrRegion | 资源所在的国家或地区。 | 字符串 |
| 地区 | 资源所在的地区、州或省。 | 字符串 |
| name | 地理或物理位置的规范名称。 | 字符串 (必需) |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 使用应用网关在内部 VNet 中创建API 管理 |
此模板演示如何在受 Azure 应用程序网关 保护的专用网络上创建 Azure API 管理 实例。 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署服务/网关资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/gateways 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/gateways@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
属性值
service/gateways
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/gateways@2022-08-01” |
| name | 资源名称 | 字符串 (必需) |
| parent_id | 此资源的父资源的 ID。 | 类型为：service 的资源的 ID |
| properties | 网关详细信息。 | GatewayContractProperties |
GatewayContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| description | 网关说明 | 字符串 |
| locationData | 网关位置。 | ResourceLocationDataContract |
ResourceLocationDataContract
| 名称 | 说明 | 值 |
|---|---|---|
| city | 资源所在的城市或位置。 | 字符串 |
| countryOrRegion | 资源所在的国家或地区。 | 字符串 |
| 地区 | 资源所在的地区、州或省。 | 字符串 |
| name | 地理或物理位置的规范名称。 | 字符串 (必需) |