Microsoft.ApiManagement 服務 2016-07-07

Bicep 資源定義

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

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

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

資源格式

若要建立 Microsoft.ApiManagement/service 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.ApiManagement/service@2016-07-07' = {
  etag: 'string'
  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

ApiManagementServiceBaseParametersTags

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

快速入門範例

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

ARM 樣本資源定義

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

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

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

資源格式

若要建立 Microsoft.ApiManagement/服務資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-07-07",
  "name": "string",
  "etag": "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

ApiManagementServiceBaseParametersTags

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

快速入門範本

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

範本	描述
使用內部 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-07-07"
  name = "string"
  etag = "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

ApiManagementServiceBaseParametersTags

ApiManagementServiceProperties

ApiManagementServicePropertiesCustomProperties

ApiManagementServiceSkuProperties

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

VirtualNetworkConfiguration