AuthorizationServer interface
代表 AuthorizationServer 的介面。
方法
| create |
建立新的授權伺服器或更新現有的授權伺服器。 |
| delete(string, string, string, string, Authorization |
刪除特定的授權伺服器實例。 |
| get(string, string, string, Authorization |
取得其識別碼所指定授權伺服器的詳細數據。 |
| get |
取得其標識碼所指定 authorizationServer 的實體狀態 （Etag） 版本。 |
| list |
列出服務實例內定義的授權伺服器集合。 |
| list |
取得授權伺服器的用戶端密碼詳細數據。 |
| update(string, string, string, string, Authorization |
更新其識別碼所指定授權伺服器的詳細數據。 |
方法詳細資料
createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)
建立新的授權伺服器或更新現有的授權伺服器。
function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- authsid
-
string
授權伺服器的識別碼。
- parameters
- AuthorizationServerContract
建立或更新參數。
選項參數。
傳回
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)
刪除特定的授權伺服器實例。
function delete(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, options?: AuthorizationServerDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- authsid
-
string
授權伺服器的識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, AuthorizationServerGetOptionalParams)
取得其識別碼所指定授權伺服器的詳細數據。
function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- authsid
-
string
授權伺服器的識別碼。
選項參數。
傳回
Promise<AuthorizationServerGetResponse>
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)
取得其標識碼所指定 authorizationServer 的實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- authsid
-
string
授權伺服器的識別碼。
選項參數。
傳回
listByService(string, string, AuthorizationServerListByServiceOptionalParams)
列出服務實例內定義的授權伺服器集合。
function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)
取得授權伺服器的用戶端密碼詳細數據。
function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- authsid
-
string
授權伺服器的識別碼。
選項參數。
傳回
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)
更新其識別碼所指定授權伺服器的詳細數據。
function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- authsid
-
string
授權伺服器的識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- AuthorizationServerUpdateContract
OAuth2 伺服器設定更新參數。
選項參數。
傳回
Promise<AuthorizationServerUpdateResponse>