共用方式為

Microsoft.ApiManagement service/apis 2018-06-01-preview

  • 發行項

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      subscriptionKeyRequired: bool
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

屬性值

ApiCreateOrUpdatePropertiesOrApiContractProperties

名字 描述 價值
apiRevision 描述 Api 的修訂。 如果未提供任何值，則會建立預設修訂 1 字串

約束：
最小長度 = 1
最大長度 = 1
apiRevisionDescription Api 修訂的描述。 字串

約束：
最大長度 =
apiType 要建立的 Api 類型。
* http 建立SOAP至REST API
* soap 建立 SOAP 傳遞 API 。		 'http'
'soap'
apiVersion 如果 API 已設定版本，則指出 API 的版本識別碼 字串

約束：
最大長度 =
apiVersionDescription Api 版本的描述。 字串

約束：
最大長度 =
apiVersionSet API 版本集合包含一組與 API 版本相關的常見組態 ApiVersionSetContractDetails
apiVersionSetId 相關 ApiVersionSet 的資源標識碼。 字串
authenticationSettings 此 API 中包含的驗證設定集合。 AuthenticationSettingsContract
contentFormat 匯入 API 的內容格式。 'openapi'
'openapi+json'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue 匯入 API 時的內容值。 字串
描述 API 的描述。 可能包含 HTML 格式標記。 字串
displayName API 名稱。 字串

約束：
最小長度 = 1
最大長度 = 1
路徑 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。 字串

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

約束：
最大長度 =
subscriptionKeyParameterNames API 可供使用之通訊協定。 SubscriptionKeyParameterNamesContract
subscriptionRequired 指定存取 API 是否需要 API 或 Product 訂用帳戶。 bool
類型 API 的類型。 'http'
'soap'
wsdlSelector 將 WSDL 匯入限制為檔的子集的準則。 ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

名字 描述 價值
wsdlEndpointName 要從 WSDL 匯入的 endpoint（port） 名稱 字串
wsdlServiceName 要從 WSDL 匯入的服務名稱 字串

ApiVersionSetContractDetails

名字 描述 價值
描述 API 版本集的描述。 字串
id 現有 API 版本集的識別碼。 省略此值以建立新的版本集。 字串
versionHeaderName 如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。 字串
versioningScheme 值，決定 API 版本識別碼在 HTTP 要求中的位置。 'Header'
'Query'
'Segment'
versionQueryName 如果 versioningScheme 設定為 query，則表示 API 版本的查詢參數名稱。 字串

AuthenticationSettingsContract

名字 描述 價值
oAuth2 OAuth2 驗證設定 OAuth2AuthenticationSettingsContract
openid OpenID Connect 驗證設定 OpenIdAuthenticationSettingsContract
subscriptionKeyRequired 指定在呼叫此 API 期間是否需要訂用帳戶密鑰，true - API 只會包含在已關閉的產品中，false - API 會單獨包含在開放式產品中，null - 產品混合在一起。 bool

Microsoft.ApiManagement/service/apis

名字 描述 價值
名字 資源名稱 字串

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

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 Api 實體建立更新屬性。 ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

名字 描述 價值
bearerTokenSendingMethods 如何將令牌傳送至伺服器。 包含任何的字串數組：
'authorizationHeader'
'query'
openidProviderId OAuth 授權伺服器標識碼。 字串

SubscriptionKeyParameterNamesContract

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

ARM 樣本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "subscriptionKeyRequired": "bool"
    },
    "contentFormat": "string",
    "contentValue": "string",
    "description": "string",
    "displayName": "string",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "type": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

屬性值

ApiCreateOrUpdatePropertiesOrApiContractProperties

名字 描述 價值
apiRevision 描述 Api 的修訂。 如果未提供任何值，則會建立預設修訂 1 字串

約束：
最小長度 = 1
最大長度 = 1
apiRevisionDescription Api 修訂的描述。 字串

約束：
最大長度 =
apiType 要建立的 Api 類型。
* http 建立SOAP至REST API
* soap 建立 SOAP 傳遞 API 。		 'http'
'soap'
apiVersion 如果 API 已設定版本，則指出 API 的版本識別碼 字串

約束：
最大長度 =
apiVersionDescription Api 版本的描述。 字串

約束：
最大長度 =
apiVersionSet API 版本集合包含一組與 API 版本相關的常見組態 ApiVersionSetContractDetails
apiVersionSetId 相關 ApiVersionSet 的資源標識碼。 字串
authenticationSettings 此 API 中包含的驗證設定集合。 AuthenticationSettingsContract
contentFormat 匯入 API 的內容格式。 'openapi'
'openapi+json'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue 匯入 API 時的內容值。 字串
描述 API 的描述。 可能包含 HTML 格式標記。 字串
displayName API 名稱。 字串

約束：
最小長度 = 1
最大長度 = 1
路徑 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。 字串

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

約束：
最大長度 =
subscriptionKeyParameterNames API 可供使用之通訊協定。 SubscriptionKeyParameterNamesContract
subscriptionRequired 指定存取 API 是否需要 API 或 Product 訂用帳戶。 bool
類型 API 的類型。 'http'
'soap'
wsdlSelector 將 WSDL 匯入限制為檔的子集的準則。 ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

名字 描述 價值
wsdlEndpointName 要從 WSDL 匯入的 endpoint（port） 名稱 字串
wsdlServiceName 要從 WSDL 匯入的服務名稱 字串

ApiVersionSetContractDetails

名字 描述 價值
描述 API 版本集的描述。 字串
id 現有 API 版本集的識別碼。 省略此值以建立新的版本集。 字串
versionHeaderName 如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。 字串
versioningScheme 值，決定 API 版本識別碼在 HTTP 要求中的位置。 'Header'
'Query'
'Segment'
versionQueryName 如果 versioningScheme 設定為 query，則表示 API 版本的查詢參數名稱。 字串

AuthenticationSettingsContract

名字 描述 價值
oAuth2 OAuth2 驗證設定 OAuth2AuthenticationSettingsContract
openid OpenID Connect 驗證設定 OpenIdAuthenticationSettingsContract
subscriptionKeyRequired 指定在呼叫此 API 期間是否需要訂用帳戶密鑰，true - API 只會包含在已關閉的產品中，false - API 會單獨包含在開放式產品中，null - 產品混合在一起。 bool

Microsoft.ApiManagement/service/apis

名字 描述 價值
apiVersion API 版本 '2018-06-01-preview'
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[^*#&+:<>?]+$ （必要）
性能 Api 實體建立更新屬性。 ApiCreateOrUpdatePropertiesOrApiContractProperties
類型 資源類型 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

名字 描述 價值
bearerTokenSendingMethods 如何將令牌傳送至伺服器。 包含任何的字串數組：
'authorizationHeader'
'query'
openidProviderId OAuth 授權伺服器標識碼。 字串

SubscriptionKeyParameterNamesContract

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

Terraform （AzAPI 提供者） 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2018-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        subscriptionKeyRequired = bool
      }
      contentFormat = "string"
      contentValue = "string"
      description = "string"
      displayName = "string"
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      type = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

屬性值

ApiCreateOrUpdatePropertiesOrApiContractProperties

名字 描述 價值
apiRevision 描述 Api 的修訂。 如果未提供任何值，則會建立預設修訂 1 字串

約束：
最小長度 = 1
最大長度 = 1
apiRevisionDescription Api 修訂的描述。 字串

約束：
最大長度 =
apiType 要建立的 Api 類型。
* http 建立SOAP至REST API
* soap 建立 SOAP 傳遞 API 。		 'http'
'soap'
apiVersion 如果 API 已設定版本，則指出 API 的版本識別碼 字串

約束：
最大長度 =
apiVersionDescription Api 版本的描述。 字串

約束：
最大長度 =
apiVersionSet API 版本集合包含一組與 API 版本相關的常見組態 ApiVersionSetContractDetails
apiVersionSetId 相關 ApiVersionSet 的資源標識碼。 字串
authenticationSettings 此 API 中包含的驗證設定集合。 AuthenticationSettingsContract
contentFormat 匯入 API 的內容格式。 'openapi'
'openapi+json'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue 匯入 API 時的內容值。 字串
描述 API 的描述。 可能包含 HTML 格式標記。 字串
displayName API 名稱。 字串

約束：
最小長度 = 1
最大長度 = 1
路徑 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。 字串

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

約束：
最大長度 =
subscriptionKeyParameterNames API 可供使用之通訊協定。 SubscriptionKeyParameterNamesContract
subscriptionRequired 指定存取 API 是否需要 API 或 Product 訂用帳戶。 bool
類型 API 的類型。 'http'
'soap'
wsdlSelector 將 WSDL 匯入限制為檔的子集的準則。 ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

名字 描述 價值
wsdlEndpointName 要從 WSDL 匯入的 endpoint（port） 名稱 字串
wsdlServiceName 要從 WSDL 匯入的服務名稱 字串

ApiVersionSetContractDetails

名字 描述 價值
描述 API 版本集的描述。 字串
id 現有 API 版本集的識別碼。 省略此值以建立新的版本集。 字串
versionHeaderName 如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。 字串
versioningScheme 值，決定 API 版本識別碼在 HTTP 要求中的位置。 'Header'
'Query'
'Segment'
versionQueryName 如果 versioningScheme 設定為 query，則表示 API 版本的查詢參數名稱。 字串

AuthenticationSettingsContract

名字 描述 價值
oAuth2 OAuth2 驗證設定 OAuth2AuthenticationSettingsContract
openid OpenID Connect 驗證設定 OpenIdAuthenticationSettingsContract
subscriptionKeyRequired 指定在呼叫此 API 期間是否需要訂用帳戶密鑰，true - API 只會包含在已關閉的產品中，false - API 會單獨包含在開放式產品中，null - 產品混合在一起。 bool

Microsoft.ApiManagement/service/apis

名字 描述 價值
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[^*#&+:<>?]+$ （必要）
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 Api 實體建立更新屬性。 ApiCreateOrUpdatePropertiesOrApiContractProperties
類型 資源類型 “Microsoft.ApiManagement/service/apis@2018-06-01-preview”

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

名字 描述 價值
bearerTokenSendingMethods 如何將令牌傳送至伺服器。 包含任何的字串數組：
'authorizationHeader'
'query'
openidProviderId OAuth 授權伺服器標識碼。 字串

SubscriptionKeyParameterNamesContract

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