Microsoft.ApiManagement 服務/閘道
Bicep 資源定義
服務/閘道資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/gateways 資源，請將下列 Bicep 新增至範本。
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'
}
}
}
屬性值
GatewayContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 閘道描述 | 字串 約束： 最大長度 = |
| locationData | 閘道位置。 | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：服務 |
| 性能 | 閘道詳細數據。 | GatewayContractProperties |
ResourceLocationDataContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 城市 | 資源所在的城市或位置。 | 字串 約束： 最大長度 = |
| countryOrRegion | 資源所在的國家或地區。 | 字串 約束： 最大長度 = |
| 區 | 資源所在的地區、州或省。 | 字串 約束： 最大長度 = |
| 名字 | 地理或實體位置的正式名稱。 | 字串 約束： 最大長度 = （必要） |
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 使用應用程式閘道在內部 VNet 中建立 API 管理 | 此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。 |
ARM 樣本資源定義
服務/閘道資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/gateways 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
屬性值
GatewayContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 閘道描述 | 字串 約束： 最大長度 = |
| locationData | 閘道位置。 | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2024-06-01-preview' |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| 性能 | 閘道詳細數據。 | GatewayContractProperties |
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/gateways' |
ResourceLocationDataContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 城市 | 資源所在的城市或位置。 | 字串 約束： 最大長度 = |
| countryOrRegion | 資源所在的國家或地區。 | 字串 約束： 最大長度 = |
| 區 | 資源所在的地區、州或省。 | 字串 約束： 最大長度 = |
| 名字 | 地理或實體位置的正式名稱。 | 字串 約束： 最大長度 = （必要） |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
使用應用程式閘道在內部 VNet 中建立 API 管理
|
此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。 |
Terraform （AzAPI 提供者） 資源定義
服務/閘道資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/gateways 資源，請將下列 Terraform 新增至您的範本。
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"
}
}
})
}
屬性值
GatewayContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 閘道描述 | 字串 約束： 最大長度 = |
| locationData | 閘道位置。 | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | 閘道詳細數據。 | GatewayContractProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/gateways@2024-06-01-preview” |
ResourceLocationDataContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 城市 | 資源所在的城市或位置。 | 字串 約束： 最大長度 = |
| countryOrRegion | 資源所在的國家或地區。 | 字串 約束： 最大長度 = |
| 區 | 資源所在的地區、州或省。 | 字串 約束： 最大長度 = |
| 名字 | 地理或實體位置的正式名稱。 | 字串 約束： 最大長度 = （必要） |