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