共用方式為

Microsoft.ApiManagement 服務/apis 2016-10-10

  • 發行項

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-10-10' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

屬性值

AuthenticationSettingsContract

名字 描述 價值
oAuth2 API OAuth2 驗證設定詳細數據。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名字 描述 價值
authenticationSettings 此 API 中包含的驗證設定集合。 AuthenticationSettingsContract
描述 API 的描述。 可能包含 HTML 格式標記。 字串
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[^*#&+:<>?]+$ （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
路徑 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。 字串

約束：
最大長度 = （必要）
協定 描述可以叫用此 API 中作業的通訊協定。 包含任何的字串數組：
'Http'
'Https' （必要）
serviceUrl 實作此 API 之後端服務的絕對 URL。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
subscriptionKeyParameterNames API 可供使用之通訊協定。 SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

名字 描述 價值
authorizationServerId OAuth 授權伺服器標識碼。 字串
範圍 作業範圍。 字串

SubscriptionKeyParameterNamesContract

名字 描述 價值
頁眉 訂用帳戶金鑰標頭名稱。 字串
查詢 訂用帳戶金鑰查詢字串參數名稱。 字串

ARM 樣本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-10-10",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

屬性值

AuthenticationSettingsContract

名字 描述 價值
oAuth2 API OAuth2 驗證設定詳細數據。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名字 描述 價值
apiVersion API 版本 '2016-10-10'
authenticationSettings 此 API 中包含的驗證設定集合。 AuthenticationSettingsContract
描述 API 的描述。 可能包含 HTML 格式標記。 字串
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[^*#&+:<>?]+$ （必要）
路徑 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。 字串

約束：
最大長度 = （必要）
協定 描述可以叫用此 API 中作業的通訊協定。 包含任何的字串數組：
'Http'
'Https' （必要）
serviceUrl 實作此 API 之後端服務的絕對 URL。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
subscriptionKeyParameterNames API 可供使用之通訊協定。 SubscriptionKeyParameterNamesContract
類型 資源類型 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

名字 描述 價值
authorizationServerId OAuth 授權伺服器標識碼。 字串
範圍 作業範圍。 字串

SubscriptionKeyParameterNamesContract

名字 描述 價值
頁眉 訂用帳戶金鑰標頭名稱。 字串
查詢 訂用帳戶金鑰查詢字串參數名稱。 字串

Terraform （AzAPI 提供者） 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-10-10"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

屬性值

AuthenticationSettingsContract

名字 描述 價值
oAuth2 API OAuth2 驗證設定詳細數據。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名字 描述 價值
authenticationSettings 此 API 中包含的驗證設定集合。 AuthenticationSettingsContract
描述 API 的描述。 可能包含 HTML 格式標記。 字串
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[^*#&+:<>?]+$ （必要）
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
路徑 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。 字串

約束：
最大長度 = （必要）
協定 描述可以叫用此 API 中作業的通訊協定。 包含任何的字串數組：
'Http'
'Https' （必要）
serviceUrl 實作此 API 之後端服務的絕對 URL。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
subscriptionKeyParameterNames API 可供使用之通訊協定。 SubscriptionKeyParameterNamesContract
類型 資源類型 “Microsoft.ApiManagement/service/apis@2016-10-10”

OAuth2AuthenticationSettingsContract

名字 描述 價值
authorizationServerId OAuth 授權伺服器標識碼。 字串
範圍 作業範圍。 字串

SubscriptionKeyParameterNamesContract

名字 描述 價值
頁眉 訂用帳戶金鑰標頭名稱。 字串
查詢 訂用帳戶金鑰查詢字串參數名稱。 字串