Microsoft.ApiManagement サービス/ゲートウェイ 2021-08-01

• 最新の を する
• 2023-09-01-preview
• 2022-08-01
• 2021-08-01

Bicep リソース定義

サービス/ゲートウェイ リソースの種類は、次をターゲットとする操作でデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/gateways リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/gateways@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

プロパティ値

service/gateways

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類 設定する方法を参照してください。	string (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	ゲートウェイの詳細。	GatewayContractProperties

GatewayContractProperties

名前	形容	価値
形容	ゲートウェイの説明	糸 制約： 最大長 = 1000
locationData	ゲートウェイの場所。	ResourceLocationDataContract

ResourceLocationDataContract

名前	形容	価値
都市	リソースが配置されている都市または地域。	糸 制約： 最大長 = 256
countryOrRegion	リソースが配置されている国またはリージョン。	糸 制約： 最大長 = 256
区	リソースが配置されている地区、州、または都道府県。	糸 制約： 最大長 = 256
名前	地理的または物理的な場所の正規名。	string (必須) 制約： 最大長 = 256

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
App Gateway を使用して内部 VNet に API Management を作成する Azure にデプロイする	このテンプレートでは、Azure Application Gateway によって保護されたプライベート ネットワーク上に Azure API Management のインスタンスを作成する方法を示します。

ARM テンプレート リソース定義

サービス/ゲートウェイ リソースの種類は、次をターゲットとする操作でデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/gateways リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ApiManagement/service/gateways",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "description": "string",
    "locationData": {
      "city": "string",
      "countryOrRegion": "string",
      "district": "string",
      "name": "string"
    }
  }
}

プロパティ値

service/gateways

名前	形容	価値
種類	リソースの種類	'Microsoft.ApiManagement/service/gateways'
apiVersion	リソース API のバージョン	'2021-08-01'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。	string (必須)
プロパティ	ゲートウェイの詳細。	GatewayContractProperties

GatewayContractProperties

名前	形容	価値
形容	ゲートウェイの説明	糸 制約： 最大長 = 1000
locationData	ゲートウェイの場所。	ResourceLocationDataContract

ResourceLocationDataContract

名前	形容	価値
都市	リソースが配置されている都市または地域。	糸 制約： 最大長 = 256
countryOrRegion	リソースが配置されている国またはリージョン。	糸 制約： 最大長 = 256
区	リソースが配置されている地区、州、または都道府県。	糸 制約： 最大長 = 256
名前	地理的または物理的な場所の正規名。	string (必須) 制約： 最大長 = 256

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
App Gateway を使用して内部 VNet に API Management を作成する Azure にデプロイする	このテンプレートでは、Azure Application Gateway によって保護されたプライベート ネットワーク上に Azure API Management のインスタンスを作成する方法を示します。

Terraform (AzAPI プロバイダー) リソース定義

サービス/ゲートウェイ リソースの種類は、次をターゲットとする操作でデプロイできます。

• リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/gateways リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      locationData = {
        city = "string"
        countryOrRegion = "string"
        district = "string"
        name = "string"
      }
    }
  })
}

プロパティ値

service/gateways

名前	形容	価値
種類	リソースの種類	"Microsoft.ApiManagement/service/gateways@2021-08-01"
名前	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	ゲートウェイの詳細。	GatewayContractProperties

GatewayContractProperties

名前	形容	価値
形容	ゲートウェイの説明	糸 制約： 最大長 = 1000
locationData	ゲートウェイの場所。	ResourceLocationDataContract

ResourceLocationDataContract

名前	形容	価値
都市	リソースが配置されている都市または地域。	糸 制約： 最大長 = 256
countryOrRegion	リソースが配置されている国またはリージョン。	糸 制約： 最大長 = 256
区	リソースが配置されている地区、州、または都道府県。	糸 制約： 最大長 = 256
名前	地理的または物理的な場所の正規名。	string (必須) 制約： 最大長 = 256