Microsoft.ApiManagement service/authorizationServers 2021-08-01

  • 發行項

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
  }
}

屬性值

service/authorizationServers

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

請參閱如何在 Bicep 中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-80

合法字元：
英數位元和連字元。

以字母開頭，並以英數位元結尾。
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 外部 OAuth 授權伺服器合約的屬性。 AuthorizationServerContractProperties

AuthorizationServerContractProperties

名字 描述 價值
authorizationEndpoint OAuth 授權端點。 請參閱 http://tools.ietf.org/html/rfc6749#section-3.2. 字串 （必要）
authorizationMethods 授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。 包含任何的字串數組：
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods 指定將存取令牌傳遞至 API 的機制。 包含任何的字串數組：
'authorizationHeader'
'query'
clientAuthenticationMethod 此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。 包含任何的字串數組：
'Basic'
'Body'
clientId 向這個授權伺服器註冊的用戶端或應用程式標識碼。 字串 （必要）
clientRegistrationEndpoint 執行此授權伺服器的用戶端或應用程式註冊頁面的選擇性參考。 包含所參考實體的絕對 URL。 字串 （必要）
clientSecret 向這個授權伺服器註冊的用戶端或應用程式密碼。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。 字串

約束：
敏感性值。 以安全參數的形式傳入。
defaultScope 預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。 字串
描述 授權伺服器的描述。 可以包含 HTML 格式標記。 字串
displayName 使用者易記的授權伺服器名稱。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 50
grantTypes 用戶端用來要求存取令牌的授權授與形式。 包含任何的字串數組：
'authorizationCode'
'clientCredentials'
'implicit'
'resourceOwnerPassword' （必要）
resourceOwnerPassword 當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。 字串
resourceOwnerUsername 當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。 字串
supportState 如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。 bool
tokenBodyParameters 此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。 TokenBodyParameterContract[]
tokenEndpoint OAuth 令牌端點。 包含所參考實體的絕對 URI。 字串

TokenBodyParameterContract

名字 描述 價值
名字 body 參數名稱。 字串 （必要）
價值 body 參數值。 字串 （必要）

ARM 樣本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string"
  }
}

屬性值

service/authorizationServers

名字 描述 價值
類型 資源類型 'Microsoft.ApiManagement/service/authorizationServers'
apiVersion 資源 API 版本 '2021-08-01'
名字 資源名稱

請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-80

合法字元：
英數位元和連字元。

以字母開頭，並以英數位元結尾。
性能 外部 OAuth 授權伺服器合約的屬性。 AuthorizationServerContractProperties

AuthorizationServerContractProperties

名字 描述 價值
authorizationEndpoint OAuth 授權端點。 請參閱 http://tools.ietf.org/html/rfc6749#section-3.2. 字串 （必要）
authorizationMethods 授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。 包含任何的字串數組：
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods 指定將存取令牌傳遞至 API 的機制。 包含任何的字串數組：
'authorizationHeader'
'query'
clientAuthenticationMethod 此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。 包含任何的字串數組：
'Basic'
'Body'
clientId 向這個授權伺服器註冊的用戶端或應用程式標識碼。 字串 （必要）
clientRegistrationEndpoint 執行此授權伺服器的用戶端或應用程式註冊頁面的選擇性參考。 包含所參考實體的絕對 URL。 字串 （必要）
clientSecret 向這個授權伺服器註冊的用戶端或應用程式密碼。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。 字串

約束：
敏感性值。 以安全參數的形式傳入。
defaultScope 預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。 字串
描述 授權伺服器的描述。 可以包含 HTML 格式標記。 字串
displayName 使用者易記的授權伺服器名稱。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 50
grantTypes 用戶端用來要求存取令牌的授權授與形式。 包含任何的字串數組：
'authorizationCode'
'clientCredentials'
'implicit'
'resourceOwnerPassword' （必要）
resourceOwnerPassword 當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。 字串
resourceOwnerUsername 當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。 字串
supportState 如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。 bool
tokenBodyParameters 此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。 TokenBodyParameterContract[]
tokenEndpoint OAuth 令牌端點。 包含所參考實體的絕對 URI。 字串

TokenBodyParameterContract

名字 描述 價值
名字 body 參數名稱。 字串 （必要）
價值 body 參數值。 字串 （必要）

Terraform （AzAPI 提供者） 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
    }
  })
}

屬性值

service/authorizationServers

名字 描述 價值
類型 資源類型 “Microsoft.ApiManagement/service/authorizationServers@2021-08-01”
名字 資源名稱 字串 （必要）

字元限制：1-80

合法字元：
英數位元和連字元。

以字母開頭，並以英數位元結尾。
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 外部 OAuth 授權伺服器合約的屬性。 AuthorizationServerContractProperties

AuthorizationServerContractProperties

名字 描述 價值
authorizationEndpoint OAuth 授權端點。 請參閱 http://tools.ietf.org/html/rfc6749#section-3.2. 字串 （必要）
authorizationMethods 授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。 包含任何的字串數組：
“DELETE”
“GET”
“HEAD”
“OPTIONS”
“PATCH”
“POST”
“PUT”
“TRACE”
bearerTokenSendingMethods 指定將存取令牌傳遞至 API 的機制。 包含任何的字串數組：
“authorizationHeader”
“query”
clientAuthenticationMethod 此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。 包含任何的字串數組：
“Basic”
“Body”
clientId 向這個授權伺服器註冊的用戶端或應用程式標識碼。 字串 （必要）
clientRegistrationEndpoint 執行此授權伺服器的用戶端或應用程式註冊頁面的選擇性參考。 包含所參考實體的絕對 URL。 字串 （必要）
clientSecret 向這個授權伺服器註冊的用戶端或應用程式密碼。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。 字串

約束：
敏感性值。 以安全參數的形式傳入。
defaultScope 預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。 字串
描述 授權伺服器的描述。 可以包含 HTML 格式標記。 字串
displayName 使用者易記的授權伺服器名稱。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 50
grantTypes 用戶端用來要求存取令牌的授權授與形式。 包含任何的字串數組：
“authorizationCode”
“clientCredentials”
“implicit”
“resourceOwnerPassword” （必要）
resourceOwnerPassword 當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。 字串
resourceOwnerUsername 當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。 字串
supportState 如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。 bool
tokenBodyParameters 此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。 TokenBodyParameterContract[]
tokenEndpoint OAuth 令牌端點。 包含所參考實體的絕對 URI。 字串

TokenBodyParameterContract

名字 描述 價值
名字 body 參數名稱。 字串 （必要）
價值 body 參數值。 字串 （必要）