Microsoft.ApiManagement サービス 2016-10-10

[アーティクル]
12/21/2024

Bicep リソース定義

サービスリソースの種類は、次を対象とする操作でデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AdditionalRegion

名前	形容	価値
場所	Azure データセンターリージョン間の追加リージョンの場所名。	string (必須)
skuType	場所の SKU の種類。	'Developer' 'Premium' 'Standard' (必須)
skuUnitCount	場所の SKU ユニット数。 SKU ユニットの最大数は SkuType によって異なります。 Developer SKU で許可される最大値は 1、Standard SKU の場合は 4、Premium SKU の場合は 10 です。	int 制約：最大値 = 10
vpnconfiguration	場所の仮想ネットワーク構成。	VirtualNetworkConfiguration

ApiManagementServiceProperties

名前	形容	価値
additionalLocations	API Management サービスの追加のデータセンターの場所。	AdditionalRegion[]
addresserEmail	アドレス指定者の電子メール。	糸
customProperties	TLS 1.0 の無効化など、API Management サービスのカスタムプロパティ。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API Management サービスのカスタムホスト名構成。	HostnameConfiguration[]
publisherEmail	発行元の電子メール。	糸制約：最大長 = (必須)
publisherName	発行元名。	string (必須)
vpnconfiguration	API Management サービスの仮想ネットワーク構成。	VirtualNetworkConfiguration
vpnType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。	'External' 'Internal' 'None'

ApiManagementServicePropertiesCustomProperties

名前	形容	価値

ApiManagementServiceSkuProperties

名前	形容	価値
能力	SKU の容量 (SKU のデプロイされたユニットの数)。既定値は 1 です。	int
名前	SKU の名前。	'Developer' 'Premium' 'Standard' (必須)

CertificateInformation

名前	形容	価値
有効期限	証明書の有効期限。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。	string (必須)
件名	証明書のサブジェクト。	string (必須)
拇印	証明書の拇印。	string (必須)

HostnameConfiguration

名前	形容	価値
証書	証明書情報。	CertificateInformation の (必須)
hostname	ホスト名。	string (必須)
種類	ホスト名の種類。	'Management' 'Portal' 'Proxy' 'Scm' (必須)

Microsoft.ApiManagement/service

名前	形容	価値
場所	リソースの場所。	string (必須)
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 パターン = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (必須)
プロパティ	API Management サービスのプロパティ。	ApiManagementServiceProperties (必須)
sku	API Management サービスの SKU プロパティ。	ApiManagementServiceSkuProperties (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

ResourceTags

名前	形容	価値

VirtualNetworkConfiguration

名前	形容	価値
場所	仮想ネットワークの場所。	糸
subnetResourceId	API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。	糸制約：パターン = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

クイックスタートのサンプル

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

Bicep ファイル	形容
内部 API Management と Web App を使用した Application Gateway の	Azure Web アプリでホストされている Web API にサービスを提供する仮想ネットワーク (内部モード) API Management インスタンスにインターネットトラフィックをルーティングする Application Gateway。
マルチリージョン Premium レベルの API Management インスタンスを作成する	このテンプレートでは、追加の場所を使用して API Management インスタンスを作成する方法を示します。プライマリの場所は、リソースグループの場所と同じです。その他の場所については、テンプレートに NorthCentralUs と米国東部 2 が表示されます。プライマリの場所は、追加の場所とは異なる必要があります。
MSI ID を持つ API Management インスタンスを作成する	このテンプレートは、MSI ID を持つ Azure API Management の開発者インスタンスを作成します
テンプレートを使用して API Management インスタンスを作成する	このテンプレートは、Azure API Management の開発者インスタンスを作成します
プライベートエンドポイントを使用して API Management サービスを作成	このテンプレートは、API Management サービス、仮想ネットワーク、および API Management サービスを仮想ネットワークに公開するプライベートエンドポイントを作成します。
KeyVault から SSL を使用して API Management サービスを作成する	このテンプレートは、ユーザー割り当て ID で構成された API Management サービスをデプロイします。この ID を使用して KeyVault から SSL 証明書をフェッチし、4 時間ごとにチェックすることで更新を維持します。
App Gateway を使用して内部 VNet に API Management を作成する	このテンプレートでは、Azure Application Gateway によって保護されたプライベートネットワーク上に Azure API Management のインスタンスを作成する方法を示します。
パブリック IP を使用して外部 VNet に API Management をデプロイする	このテンプレートでは、外部モードで仮想ネットワークのサブネット内の Premium レベルで Azure API Management のインスタンスを作成し、そのサブネットで推奨される NSG 規則を構成する方法を示します。インスタンスは 2 つの可用性ゾーンにデプロイされます。このテンプレートでは、サブスクリプションのパブリック IP アドレスも構成されます。
パブリック IP を使用して内部 VNet に API Management をデプロイする	このテンプレートでは、内部モードで仮想ネットワークのサブネット内の Premium レベルで Azure API Management のインスタンスを作成し、そのサブネットで推奨される NSG 規則を構成する方法を示します。インスタンスは 2 つの可用性ゾーンにデプロイされます。このテンプレートでは、サブスクリプションのパブリック IP アドレスも構成されます。
Api Management を Availability Zones にデプロイする	このテンプレートは、Azure API Management の Premium インスタンスを作成し、可用性ゾーンにデプロイします
外部の Azure Cache for Redis を使用して API Management をデプロイする	このテンプレートでは、外部 Azure Cache for Redis インスタンスを API Management 外部キャッシュとして使用層に Azure API Management のインスタンスを作成する方法を示します。
API Management の配信元を使用した Front Door Standard/Premium の	このテンプレートは、Front Door Premium と API Management インスタンスを作成し、NSG とグローバル API Management ポリシーを使用して、トラフィックが Front Door の配信元を通過したことを検証します。

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

サービスリソースの種類は、次を対象とする操作でデプロイできます。

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

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AdditionalRegion

名前	形容	価値
場所	Azure データセンターリージョン間の追加リージョンの場所名。	string (必須)
skuType	場所の SKU の種類。	'Developer' 'Premium' 'Standard' (必須)
skuUnitCount	場所の SKU ユニット数。 SKU ユニットの最大数は SkuType によって異なります。 Developer SKU で許可される最大値は 1、Standard SKU の場合は 4、Premium SKU の場合は 10 です。	int 制約：最大値 = 10
vpnconfiguration	場所の仮想ネットワーク構成。	VirtualNetworkConfiguration

ApiManagementServiceProperties

名前	形容	価値
additionalLocations	API Management サービスの追加のデータセンターの場所。	AdditionalRegion[]
addresserEmail	アドレス指定者の電子メール。	糸
customProperties	TLS 1.0 の無効化など、API Management サービスのカスタムプロパティ。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API Management サービスのカスタムホスト名構成。	HostnameConfiguration[]
publisherEmail	発行元の電子メール。	糸制約：最大長 = (必須)
publisherName	発行元名。	string (必須)
vpnconfiguration	API Management サービスの仮想ネットワーク構成。	VirtualNetworkConfiguration
vpnType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。	'External' 'Internal' 'None'

ApiManagementServicePropertiesCustomProperties

名前	形容	価値

ApiManagementServiceSkuProperties

名前	形容	価値
能力	SKU の容量 (SKU のデプロイされたユニットの数)。既定値は 1 です。	int
名前	SKU の名前。	'Developer' 'Premium' 'Standard' (必須)

CertificateInformation

名前	形容	価値
有効期限	証明書の有効期限。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。	string (必須)
件名	証明書のサブジェクト。	string (必須)
拇印	証明書の拇印。	string (必須)

HostnameConfiguration

名前	形容	価値
証書	証明書情報。	CertificateInformation の (必須)
hostname	ホスト名。	string (必須)
種類	ホスト名の種類。	'Management' 'Portal' 'Proxy' 'Scm' (必須)

Microsoft.ApiManagement/service

名前	形容	価値
apiVersion	API のバージョン	'2016-10-10'
場所	リソースの場所。	string (必須)
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 パターン = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (必須)
プロパティ	API Management サービスのプロパティ。	ApiManagementServiceProperties (必須)
sku	API Management サービスの SKU プロパティ。	ApiManagementServiceSkuProperties (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.ApiManagement/service'

ResourceTags

名前	形容	価値

VirtualNetworkConfiguration

名前	形容	価値
場所	仮想ネットワークの場所。	糸
subnetResourceId	API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。	糸制約：パターン = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

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

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

テンプレート	形容
内部 API Management と Web App を使用した Application Gateway の Azure にデプロイする	Azure Web アプリでホストされている Web API にサービスを提供する仮想ネットワーク (内部モード) API Management インスタンスにインターネットトラフィックをルーティングする Application Gateway。
マルチリージョン Premium レベルの API Management インスタンスを作成する Azure にデプロイする	このテンプレートでは、追加の場所を使用して API Management インスタンスを作成する方法を示します。プライマリの場所は、リソースグループの場所と同じです。その他の場所については、テンプレートに NorthCentralUs と米国東部 2 が表示されます。プライマリの場所は、追加の場所とは異なる必要があります。
テンプレートを使用して API Management インスタンスとすべてのサブリソースを作成する Azure にデプロイする	このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します
MSI ID を持つ API Management インスタンスを作成する Azure にデプロイする	このテンプレートは、MSI ID を持つ Azure API Management の開発者インスタンスを作成します
テンプレートを使用して API Management インスタンスを作成する Azure にデプロイする	このテンプレートは、Azure API Management の開発者インスタンスを作成します
カスタムホスト名を使用して API Management インスタンスを作成 Azure にデプロイする	このテンプレートでは、ポータル用のカスタムホスト名とプロキシ用の複数のカスタムホスト名を使用して Azure API Management のインスタンスを作成する方法を示します
プライベートエンドポイントを使用して API Management サービスを作成 Azure にデプロイする	このテンプレートは、API Management サービス、仮想ネットワーク、および API Management サービスを仮想ネットワークに公開するプライベートエンドポイントを作成します。
KeyVault から SSL を使用して API Management サービスを作成する Azure にデプロイする	このテンプレートは、ユーザー割り当て ID で構成された API Management サービスをデプロイします。この ID を使用して KeyVault から SSL 証明書をフェッチし、4 時間ごとにチェックすることで更新を維持します。
API Management インスタンスの作成と監視 Azure にデプロイする	このテンプレートは、Azure API Management サービスと Log Analytics ワークスペースのインスタンスを作成し、Log Analytics を使用して API Management サービスの監視を設定します
App Gateway を使用して内部 VNet に API Management を作成する Azure にデプロイする	このテンプレートでは、Azure Application Gateway によって保護されたプライベートネットワーク上に Azure API Management のインスタンスを作成する方法を示します。
KeyVault を使用してカスタムプロキシ ssl を使用して API Management を作成する Azure にデプロイする	このテンプレートでは、Azure API Management のインスタンスを作成し、keyvault の ssl 証明書を使用してプロキシのカスタムホスト名を構成する方法を示します。
Azure API Management の前に Azure Front Door を作成する Azure にデプロイする	このサンプルでは、Azure API Management の前でグローバルロードバランサーとして Azure Front Door を使用する方法を示します。
パブリック IP を使用して外部 VNet に API Management をデプロイする Azure にデプロイする	このテンプレートでは、外部モードで仮想ネットワークのサブネット内の Premium レベルで Azure API Management のインスタンスを作成し、そのサブネットで推奨される NSG 規則を構成する方法を示します。インスタンスは 2 つの可用性ゾーンにデプロイされます。このテンプレートでは、サブスクリプションのパブリック IP アドレスも構成されます。
パブリック IP を使用して内部 VNet に API Management をデプロイする Azure にデプロイする	このテンプレートでは、内部モードで仮想ネットワークのサブネット内の Premium レベルで Azure API Management のインスタンスを作成し、そのサブネットで推奨される NSG 規則を構成する方法を示します。インスタンスは 2 つの可用性ゾーンにデプロイされます。このテンプレートでは、サブスクリプションのパブリック IP アドレスも構成されます。
Api Management を Availability Zones にデプロイする Azure にデプロイする	このテンプレートは、Azure API Management の Premium インスタンスを作成し、可用性ゾーンにデプロイします
外部の Azure Cache for Redis を使用して API Management をデプロイする Azure にデプロイする	このテンプレートでは、外部 Azure Cache for Redis インスタンスを API Management 外部キャッシュとして使用層に Azure API Management のインスタンスを作成する方法を示します。
API Management の配信元を使用した Front Door Standard/Premium の Azure にデプロイする	このテンプレートは、Front Door Premium と API Management インスタンスを作成し、NSG とグローバル API Management ポリシーを使用して、トラフィックが Front Door の配信元を通過したことを検証します。

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

サービスリソースの種類は、次を対象とする操作でデプロイできます。

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

プロパティ値

AdditionalRegion

名前	形容	価値
場所	Azure データセンターリージョン間の追加リージョンの場所名。	string (必須)
skuType	場所の SKU の種類。	'Developer' 'Premium' 'Standard' (必須)
skuUnitCount	場所の SKU ユニット数。 SKU ユニットの最大数は SkuType によって異なります。 Developer SKU で許可される最大値は 1、Standard SKU の場合は 4、Premium SKU の場合は 10 です。	int 制約：最大値 = 10
vpnconfiguration	場所の仮想ネットワーク構成。	VirtualNetworkConfiguration

ApiManagementServiceProperties

名前	形容	価値
additionalLocations	API Management サービスの追加のデータセンターの場所。	AdditionalRegion[]
addresserEmail	アドレス指定者の電子メール。	糸
customProperties	TLS 1.0 の無効化など、API Management サービスのカスタムプロパティ。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API Management サービスのカスタムホスト名構成。	HostnameConfiguration[]
publisherEmail	発行元の電子メール。	糸制約：最大長 = (必須)
publisherName	発行元名。	string (必須)
vpnconfiguration	API Management サービスの仮想ネットワーク構成。	VirtualNetworkConfiguration
vpnType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。	'External' 'Internal' 'None'

ApiManagementServicePropertiesCustomProperties

名前	形容	価値

ApiManagementServiceSkuProperties

名前	形容	価値
能力	SKU の容量 (SKU のデプロイされたユニットの数)。既定値は 1 です。	int
名前	SKU の名前。	'Developer' 'Premium' 'Standard' (必須)

CertificateInformation

名前	形容	価値
有効期限	証明書の有効期限。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。	string (必須)
件名	証明書のサブジェクト。	string (必須)
拇印	証明書の拇印。	string (必須)

HostnameConfiguration

名前	形容	価値
証書	証明書情報。	CertificateInformation の (必須)
hostname	ホスト名。	string (必須)
種類	ホスト名の種類。	'Management' 'Portal' 'Proxy' 'Scm' (必須)

Microsoft.ApiManagement/service

名前	形容	価値
場所	リソースの場所。	string (必須)
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 パターン = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (必須)
プロパティ	API Management サービスのプロパティ。	ApiManagementServiceProperties (必須)
sku	API Management サービスの SKU プロパティ。	ApiManagementServiceSkuProperties (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.ApiManagement/service@2016-10-10"

ResourceTags

名前	形容	価値

VirtualNetworkConfiguration

名前	形容	価値
場所	仮想ネットワークの場所。	糸
subnetResourceId	API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。	糸制約：パターン = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

次の方法で共有

Microsoft.ApiManagement サービス 2016-10-10

Bicep リソース定義

リソースの形式

プロパティ値

AdditionalRegion

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

ResourceTags

VirtualNetworkConfiguration

クイック スタートのサンプル

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

リソースの形式

プロパティ値

AdditionalRegion

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

ResourceTags

VirtualNetworkConfiguration

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

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

リソースの形式

プロパティ値

AdditionalRegion

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

ResourceTags

VirtualNetworkConfiguration

フィードバック

その他のリソース

クイックスタートのサンプル

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

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