Microsoft.ApiManagement/service 2016-10-10 - Bicep, ARM template & Terraform AzAPI reference

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 資料中心區域之間其他區域的位置名稱。	字串（必要）
skuType	位置中的 SKU 類型。	'Developer' 'Premium' 'Standard' （必要）
skuUnitCount	位置的 SKU 單位計數。 SKU 單位計數上限取決於 SkuType。開發人員 SKU 允許的最大值為 1，標準 SKU 為 4，而進階 SKU 則為 10，位於位置。	int 約束：最大值 = 10
vpnconfiguration	位置的虛擬網路組態。	VirtualNetworkConfiguration

ApiManagementServiceProperties

名字	描述	價值
additionalLocations	API 管理服務的其他數據中心位置。	AdditionalRegion[]
addresserEmail	尋址者電子郵件。	字串
customProperties	API 管理服務的自定義屬性，例如停用 TLS 1.0。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API 管理服務的自定義主機名組態。	HostnameConfiguration[]
publisherEmail	發行者電子郵件。	字串約束：最大長度 = （必要）
publisherName	發行者名稱。	字串（必要）
vpnconfiguration	API 管理服務的虛擬網路組態。	VirtualNetworkConfiguration
vpnType	必須在其中設定 API 管理服務的 VPN 類型。無（預設值）表示 API 管理服務不屬於任何虛擬網路，外部表示 API 管理部署是在具有因特網面向端點的虛擬網路內設定，而內部表示 API 管理部署只會在具有內部網路對向端點的虛擬網路內進行設定。	'External' 'Internal' 'None'

ApiManagementServicePropertiesCustomProperties

名字	描述	價值

ApiManagementServiceSkuProperties

名字	描述	價值
能力	SKU 的容量（SKU 的部署單位數目）。預設值為 1。	int
名字	Sku 的名稱。	'Developer' 'Premium' 'Standard' （必要）

CertificateInformation

名字	描述	價值
滿期	憑證的到期日。日期符合下列格式：`yyyy-MM-ddTHH:mm:ssZ` ISO 8601 標準所指定。	字串（必要）
主題	憑證的主體。	字串（必要）
指紋	憑證的指紋。	字串（必要）

HostnameConfiguration

名字	描述	價值
證書	憑證資訊。	CertificateInformation （必要）
hostname	主機名。	字串（必要）
類型	主機名類型。	'Management' 'Portal' 'Proxy' 'Scm' （必要）

Microsoft.ApiManagement/service

名字	描述	價值
位置	資源位置。	字串（必要）
名字	資源名稱	字串約束：最小長度 = 1 最大長度 = 1 模式 = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` （必要）
性能	API 管理服務的屬性。	ApiManagementServiceProperties （必要）
sku	API 管理服務的 SKU 屬性。	ApiManagementServiceSkuProperties （必要）
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

ResourceTags

名字	描述	價值

VirtualNetworkConfiguration

名字	描述	價值
位置	虛擬網路的位置。	字串
subnetResourceId	虛擬網路中要部署 API 管理服務之子網的完整資源識別碼。	字串約束： Pattern = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
使用內部 API 管理和 Web 應用程式應用程式閘道	應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）API 管理實例，此實例會服務裝載於 Azure Web 應用程式中的 Web API。
建立多區域進階層 API 管理實例	此範本示範如何使用其他位置建立 API 管理實例。主要位置與資源群組的位置相同。針對其他位置，範本會顯示 NorthCentralUs 和美國東部 2。主要位置應該不同於其他位置。
建立具有 MSI 身分識別的 API 管理實例	此範本會建立具有 MSI 身分識別的 Azure API 管理的開發人員實例
使用範本建立 API 管理實例	此範本會建立 Azure API 管理的開發人員實例
使用私人端點建立 API 管理服務	此範本會建立 API 管理服務、虛擬網路，以及將 API 管理服務公開至虛擬網路的私人端點。
從 KeyVault 建立具有 SSL 的 API 管理服務	此範本會部署使用使用者指派身分識別設定的 API 管理服務。它會使用此身分識別從 KeyVault 擷取 SSL 憑證，並每隔 4 小時檢查一次來保持更新。
使用應用程式閘道在內部 VNet 中建立 API 管理	此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。
使用公用IP 在外部 VNet 中部署 API 管理	此範本示範如何在虛擬網路子網外部模式的進階層中建立 Azure API 管理的實例，並在子網上設定建議的 NSG 規則。實例會部署到兩個可用性區域。此範本也會從您的訂用帳戶設定公用IP位址。
使用公用IP 在內部 VNet 中部署 API 管理	此範本示範如何在虛擬網路子網內部的進階層中建立 Azure API 管理的實例，並在子網上設定建議的 NSG 規則。實例會部署到兩個可用性區域。此範本也會從您的訂用帳戶設定公用IP位址。
將 API 管理部署到可用性區域	此範本會建立 Azure API 管理的進階實例，並部署到可用性區域
使用外部 Azure Cache for Redis 部署 API 管理	此範本示範如何使用外部 Azure Cache for Redis 實例作為 API 管理外部快取，在取用層中建立 Azure API 管理的實例。
使用 API 管理來源 Front Door Standard/Premium	此範本會建立 Front Door Premium 和 API 管理實例，並使用 NSG 和全域 API 管理原則來驗證流量是否通過 Front Door 來源。

ARM 樣本資源定義

服務資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/服務資源，請將下列 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 資料中心區域之間其他區域的位置名稱。	字串（必要）
skuType	位置中的 SKU 類型。	'Developer' 'Premium' 'Standard' （必要）
skuUnitCount	位置的 SKU 單位計數。 SKU 單位計數上限取決於 SkuType。開發人員 SKU 允許的最大值為 1，標準 SKU 為 4，而進階 SKU 則為 10，位於位置。	int 約束：最大值 = 10
vpnconfiguration	位置的虛擬網路組態。	VirtualNetworkConfiguration

ApiManagementServiceProperties

名字	描述	價值
additionalLocations	API 管理服務的其他數據中心位置。	AdditionalRegion[]
addresserEmail	尋址者電子郵件。	字串
customProperties	API 管理服務的自定義屬性，例如停用 TLS 1.0。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API 管理服務的自定義主機名組態。	HostnameConfiguration[]
publisherEmail	發行者電子郵件。	字串約束：最大長度 = （必要）
publisherName	發行者名稱。	字串（必要）
vpnconfiguration	API 管理服務的虛擬網路組態。	VirtualNetworkConfiguration
vpnType	必須在其中設定 API 管理服務的 VPN 類型。無（預設值）表示 API 管理服務不屬於任何虛擬網路，外部表示 API 管理部署是在具有因特網面向端點的虛擬網路內設定，而內部表示 API 管理部署只會在具有內部網路對向端點的虛擬網路內進行設定。	'External' 'Internal' 'None'

ApiManagementServicePropertiesCustomProperties

名字	描述	價值

ApiManagementServiceSkuProperties

名字	描述	價值
能力	SKU 的容量（SKU 的部署單位數目）。預設值為 1。	int
名字	Sku 的名稱。	'Developer' 'Premium' 'Standard' （必要）

CertificateInformation

名字	描述	價值
滿期	憑證的到期日。日期符合下列格式：`yyyy-MM-ddTHH:mm:ssZ` ISO 8601 標準所指定。	字串（必要）
主題	憑證的主體。	字串（必要）
指紋	憑證的指紋。	字串（必要）

HostnameConfiguration

名字	描述	價值
證書	憑證資訊。	CertificateInformation （必要）
hostname	主機名。	字串（必要）
類型	主機名類型。	'Management' 'Portal' 'Proxy' 'Scm' （必要）

Microsoft.ApiManagement/service

名字	描述	價值
apiVersion	API 版本	'2016-10-10'
位置	資源位置。	字串（必要）
名字	資源名稱	字串約束：最小長度 = 1 最大長度 = 1 模式 = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` （必要）
性能	API 管理服務的屬性。	ApiManagementServiceProperties （必要）
sku	API 管理服務的 SKU 屬性。	ApiManagementServiceSkuProperties （必要）
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.ApiManagement/service'

ResourceTags

名字	描述	價值

VirtualNetworkConfiguration

名字	描述	價值
位置	虛擬網路的位置。	字串
subnetResourceId	虛擬網路中要部署 API 管理服務之子網的完整資源識別碼。	字串約束： Pattern = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用內部 API 管理和 Web 應用程式應用程式閘道	應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）API 管理實例，此實例會服務裝載於 Azure Web 應用程式中的 Web API。
建立多區域進階層 API 管理實例	此範本示範如何使用其他位置建立 API 管理實例。主要位置與資源群組的位置相同。針對其他位置，範本會顯示 NorthCentralUs 和美國東部 2。主要位置應該不同於其他位置。
使用範本建立 API 管理實例和所有子資源	此範本示範如何建立 API 管理服務及設定子實體
建立具有 MSI 身分識別的 API 管理實例	此範本會建立具有 MSI 身分識別的 Azure API 管理的開發人員實例
使用範本建立 API 管理實例	此範本會建立 Azure API 管理的開發人員實例
使用自定義主機名建立 API 管理實例	此範本示範如何使用入口網站的自定義主機名和 Proxy 的多個自定義主機名來建立 Azure API 管理的實例
使用私人端點建立 API 管理服務	此範本會建立 API 管理服務、虛擬網路，以及將 API 管理服務公開至虛擬網路的私人端點。
從 KeyVault 建立具有 SSL 的 API 管理服務	此範本會部署使用使用者指派身分識別設定的 API 管理服務。它會使用此身分識別從 KeyVault 擷取 SSL 憑證，並每隔 4 小時檢查一次來保持更新。
建立和監視 API 管理實例	此範本會建立 Azure API 管理服務和 Log Analytics 工作區的實例，並使用 Log Analytics 設定 API 管理服務的監視
使用應用程式閘道在內部 VNet 中建立 API 管理	此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。
使用 KeyVault 使用自定義 Proxy ssl 建立 API 管理	此範本示範如何建立 Azure API 管理的實例，並使用keyvault的ssl憑證來設定 Proxy 的自定義主機名。
在 Azure API 管理前建立 Azure Front Door	此範例示範如何在 Azure API 管理前使用 Azure Front Door 作為全域負載平衡器。
使用公用IP 在外部 VNet 中部署 API 管理	此範本示範如何在虛擬網路子網外部模式的進階層中建立 Azure API 管理的實例，並在子網上設定建議的 NSG 規則。實例會部署到兩個可用性區域。此範本也會從您的訂用帳戶設定公用IP位址。
使用公用IP 在內部 VNet 中部署 API 管理	此範本示範如何在虛擬網路子網內部的進階層中建立 Azure API 管理的實例，並在子網上設定建議的 NSG 規則。實例會部署到兩個可用性區域。此範本也會從您的訂用帳戶設定公用IP位址。
將 API 管理部署到可用性區域	此範本會建立 Azure API 管理的進階實例，並部署到可用性區域
使用外部 Azure Cache for Redis 部署 API 管理	此範本示範如何使用外部 Azure Cache for Redis 實例作為 API 管理外部快取，在取用層中建立 Azure API 管理的實例。
使用 API 管理來源 Front Door Standard/Premium	此範本會建立 Front Door Premium 和 API 管理實例，並使用 NSG 和全域 API 管理原則來驗證流量是否通過 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 資料中心區域之間其他區域的位置名稱。	字串（必要）
skuType	位置中的 SKU 類型。	'Developer' 'Premium' 'Standard' （必要）
skuUnitCount	位置的 SKU 單位計數。 SKU 單位計數上限取決於 SkuType。開發人員 SKU 允許的最大值為 1，標準 SKU 為 4，而進階 SKU 則為 10，位於位置。	int 約束：最大值 = 10
vpnconfiguration	位置的虛擬網路組態。	VirtualNetworkConfiguration

ApiManagementServiceProperties

名字	描述	價值
additionalLocations	API 管理服務的其他數據中心位置。	AdditionalRegion[]
addresserEmail	尋址者電子郵件。	字串
customProperties	API 管理服務的自定義屬性，例如停用 TLS 1.0。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API 管理服務的自定義主機名組態。	HostnameConfiguration[]
publisherEmail	發行者電子郵件。	字串約束：最大長度 = （必要）
publisherName	發行者名稱。	字串（必要）
vpnconfiguration	API 管理服務的虛擬網路組態。	VirtualNetworkConfiguration
vpnType	必須在其中設定 API 管理服務的 VPN 類型。無（預設值）表示 API 管理服務不屬於任何虛擬網路，外部表示 API 管理部署是在具有因特網面向端點的虛擬網路內設定，而內部表示 API 管理部署只會在具有內部網路對向端點的虛擬網路內進行設定。	'External' 'Internal' 'None'

ApiManagementServicePropertiesCustomProperties

名字	描述	價值

ApiManagementServiceSkuProperties

名字	描述	價值
能力	SKU 的容量（SKU 的部署單位數目）。預設值為 1。	int
名字	Sku 的名稱。	'Developer' 'Premium' 'Standard' （必要）

CertificateInformation

名字	描述	價值
滿期	憑證的到期日。日期符合下列格式：`yyyy-MM-ddTHH:mm:ssZ` ISO 8601 標準所指定。	字串（必要）
主題	憑證的主體。	字串（必要）
指紋	憑證的指紋。	字串（必要）

HostnameConfiguration

名字	描述	價值
證書	憑證資訊。	CertificateInformation （必要）
hostname	主機名。	字串（必要）
類型	主機名類型。	'Management' 'Portal' 'Proxy' 'Scm' （必要）

Microsoft.ApiManagement/service

名字	描述	價值
位置	資源位置。	字串（必要）
名字	資源名稱	字串約束：最小長度 = 1 最大長度 = 1 模式 = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` （必要）
性能	API 管理服務的屬性。	ApiManagementServiceProperties （必要）
sku	API 管理服務的 SKU 屬性。	ApiManagementServiceSkuProperties （必要）
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.ApiManagement/service@2016-10-10”

ResourceTags

名字	描述	價值

VirtualNetworkConfiguration

名字	描述	價值
位置	虛擬網路的位置。	字串
subnetResourceId	虛擬網路中要部署 API 管理服務之子網的完整資源識別碼。	字串約束： Pattern = `^/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

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義