共用方式為

AuthorizationServerContract interface

  • 參考
套件:
@azure/arm-apimanagement

外部 OAuth 授權伺服器設定。

Extends
ProxyResource

屬性

authorizationEndpoint

OAuth 授權端點。 請參閱 http://tools.ietf.org/html/rfc6749#section-3.2。
authorizationMethods

授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。
bearerTokenSendingMethods

指定將存取令牌傳遞至 API 的機制。
clientAuthenticationMethod

此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。
clientId

向這個授權伺服器註冊的用戶端或應用程式標識碼。
clientRegistrationEndpoint

執行此授權伺服器的用戶端或應用程式註冊頁面的選擇性參考。 包含所參考實體的絕對 URL。
clientSecret

向這個授權伺服器註冊的用戶端或應用程式密碼。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。
defaultScope

預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。
description

授權伺服器的描述。 可以包含 HTML 格式標記。
displayName

使用者易記的授權伺服器名稱。
grantTypes

用戶端用來要求存取令牌的授權授與形式。
resourceOwnerPassword

當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。
resourceOwnerUsername

當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。
supportState

如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。
tokenBodyParameters

此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。
tokenEndpoint

OAuth 令牌端點。 包含所參考實體的絕對 URI。
useInApiDocumentation

如果為 true，授權伺服器將會用於開發人員入口網站中的 API 檔。 如果未提供任何值，則預設為 False。
useInTestConsole

如果為 true，授權伺服器可以在開發人員入口網站測試控制台中使用。 如果未提供任何值，則預設為 True。

繼承的屬性

id

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此屬性將不會串行化。 它只能由伺服器填入。
name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
type

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

屬性詳細資料

authorizationEndpoint

OAuth 授權端點。 請參閱 http://tools.ietf.org/html/rfc6749#section-3.2。

authorizationEndpoint?: string

屬性值

string

authorizationMethods

授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。

authorizationMethods?: AuthorizationMethod[]

屬性值

AuthorizationMethod[]

bearerTokenSendingMethods

指定將存取令牌傳遞至 API 的機制。

bearerTokenSendingMethods?: string[]

屬性值

string[]

clientAuthenticationMethod

此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。

clientAuthenticationMethod?: string[]

屬性值

string[]

clientId

向這個授權伺服器註冊的用戶端或應用程式標識碼。

clientId?: string

屬性值

string

clientRegistrationEndpoint

執行此授權伺服器的用戶端或應用程式註冊頁面的選擇性參考。 包含所參考實體的絕對 URL。

clientRegistrationEndpoint?: string

屬性值

string

clientSecret

向這個授權伺服器註冊的用戶端或應用程式密碼。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。

clientSecret?: string

屬性值

string

defaultScope

預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。

defaultScope?: string

屬性值

string

description

授權伺服器的描述。 可以包含 HTML 格式標記。

description?: string

屬性值

string

displayName

使用者易記的授權伺服器名稱。

displayName?: string

屬性值

string

grantTypes

用戶端用來要求存取令牌的授權授與形式。

grantTypes?: string[]

屬性值

string[]

resourceOwnerPassword

當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。

resourceOwnerPassword?: string

屬性值

string

resourceOwnerUsername

當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。

resourceOwnerUsername?: string

屬性值

string

supportState

如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。

supportState?: boolean

屬性值

boolean

tokenBodyParameters

此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。

tokenBodyParameters?: TokenBodyParameterContract[]

屬性值

TokenBodyParameterContract[]

tokenEndpoint

OAuth 令牌端點。 包含所參考實體的絕對 URI。

tokenEndpoint?: string

屬性值

string

useInApiDocumentation

如果為 true，授權伺服器將會用於開發人員入口網站中的 API 檔。 如果未提供任何值，則預設為 False。

useInApiDocumentation?: boolean

屬性值

boolean

useInTestConsole

如果為 true，授權伺服器可以在開發人員入口網站測試控制台中使用。 如果未提供任何值，則預設為 True。

useInTestConsole?: boolean

屬性值

boolean

繼承的屬性詳細資料

id

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此屬性將不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自ProxyResource.id

name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自ProxyResource.name

type

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自ProxyResource.type