Microsoft.ApiManagement ゲートウェイ 2024-05-01
Bicep リソース定義
ゲートウェイ リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/gateways リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/gateways@2024-05-01' = {
location: 'string'
name: 'string'
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
ApiManagementGatewayProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| バックエンド | ゲートウェイをバックエンド システムと統合する方法に関する情報。 | BackendConfiguration |
| configurationApi | API Management ゲートウェイの構成 API に関する情報。 これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。 | GatewayConfigurationApi |
| フロントエンド | ゲートウェイを公開する方法に関する情報。 | FrontendConfiguration |
| virtualNetworkType | API Management ゲートウェイを構成する必要がある VPN の種類。 | 'External' 'Internal' 'None' |
ApiManagementGatewaySkuProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 能力 | SKU の容量 (SKU のデプロイされたユニットの数) | int |
| 名前 | SKU の名前。 | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (必須) |
ApimResourceTags
| 名前 | 形容 | 価値 |
|---|
BackendConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| サブネット | 要求の送信先となるデータ プレーン ゲートウェイの既定のホスト名。 | BackendSubnetConfiguration |
BackendSubnetConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | バックエンド システムがホストされているサブネットの ARM ID。 | 糸 |
FrontendConfiguration
| 名前 | 形容 | 価値 |
|---|
GatewayConfigurationApi
| 名前 | 形容 | 価値 |
|---|
Microsoft.ApiManagement/gateways
| 名前 | 形容 | 価値 |
|---|---|---|
| 場所 | リソースの場所。 | string (必須) |
| 名前 | リソース名 | 糸 制約： 最小長 = 1 最大長 = 45 パターン = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (必須) |
| プロパティ | API Management ゲートウェイのプロパティ。 | ApiManagementGatewayProperties (必須) |
| sku | API Management ゲートウェイの SKU プロパティ。 | ApiManagementGatewaySkuProperties (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
ARM テンプレート リソース定義
ゲートウェイ リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/gateways リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2024-05-01",
"name": "string",
"location": "string",
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {
},
"frontend": {
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
ApiManagementGatewayProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| バックエンド | ゲートウェイをバックエンド システムと統合する方法に関する情報。 | BackendConfiguration |
| configurationApi | API Management ゲートウェイの構成 API に関する情報。 これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。 | GatewayConfigurationApi |
| フロントエンド | ゲートウェイを公開する方法に関する情報。 | FrontendConfiguration |
| virtualNetworkType | API Management ゲートウェイを構成する必要がある VPN の種類。 | 'External' 'Internal' 'None' |
ApiManagementGatewaySkuProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 能力 | SKU の容量 (SKU のデプロイされたユニットの数) | int |
| 名前 | SKU の名前。 | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (必須) |
ApimResourceTags
| 名前 | 形容 | 価値 |
|---|
BackendConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| サブネット | 要求の送信先となるデータ プレーン ゲートウェイの既定のホスト名。 | BackendSubnetConfiguration |
BackendSubnetConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | バックエンド システムがホストされているサブネットの ARM ID。 | 糸 |
FrontendConfiguration
| 名前 | 形容 | 価値 |
|---|
GatewayConfigurationApi
| 名前 | 形容 | 価値 |
|---|
Microsoft.ApiManagement/gateways
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2024-05-01' |
| 場所 | リソースの場所。 | string (必須) |
| 名前 | リソース名 | 糸 制約： 最小長 = 1 最大長 = 45 パターン = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (必須) |
| プロパティ | API Management ゲートウェイのプロパティ。 | ApiManagementGatewayProperties (必須) |
| sku | API Management ゲートウェイの SKU プロパティ。 | ApiManagementGatewaySkuProperties (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/gateways' |
Terraform (AzAPI プロバイダー) リソース定義
ゲートウェイ リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/gateways リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2024-05-01"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {
}
frontend = {
}
virtualNetworkType = "string"
}
})
}
プロパティ値
ApiManagementGatewayProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| バックエンド | ゲートウェイをバックエンド システムと統合する方法に関する情報。 | BackendConfiguration |
| configurationApi | API Management ゲートウェイの構成 API に関する情報。 これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。 | GatewayConfigurationApi |
| フロントエンド | ゲートウェイを公開する方法に関する情報。 | FrontendConfiguration |
| virtualNetworkType | API Management ゲートウェイを構成する必要がある VPN の種類。 | 'External' 'Internal' 'None' |
ApiManagementGatewaySkuProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 能力 | SKU の容量 (SKU のデプロイされたユニットの数) | int |
| 名前 | SKU の名前。 | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (必須) |
ApimResourceTags
| 名前 | 形容 | 価値 |
|---|
BackendConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| サブネット | 要求の送信先となるデータ プレーン ゲートウェイの既定のホスト名。 | BackendSubnetConfiguration |
BackendSubnetConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | バックエンド システムがホストされているサブネットの ARM ID。 | 糸 |
FrontendConfiguration
| 名前 | 形容 | 価値 |
|---|
GatewayConfigurationApi
| 名前 | 形容 | 価値 |
|---|
Microsoft.ApiManagement/gateways
| 名前 | 形容 | 価値 |
|---|---|---|
| 場所 | リソースの場所。 | string (必須) |
| 名前 | リソース名 | 糸 制約： 最小長 = 1 最大長 = 45 パターン = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (必須) |
| プロパティ | API Management ゲートウェイのプロパティ。 | ApiManagementGatewayProperties (必須) |
| sku | API Management ゲートウェイの SKU プロパティ。 | ApiManagementGatewaySkuProperties (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 |
| 種類 | リソースの種類 | "Microsoft.ApiManagement/gateways@2024-05-01" |