IdentityProvider interface
表示 IdentityProvider 的介面。
方法
| create |
建立或更新 IdentityProvider 組態。 |
| delete(string, string, string, string, Identity |
刪除指定的識別提供者組態。 |
| get(string, string, string, Identity |
取得指定之服務實例中所設定之識別提供者的組態詳細資料。 |
| get |
取得實體狀態 (Etag) 其識別碼所指定的 identityProvider 版本。 |
| list |
列出指定之服務實例中設定的識別提供者集合。 |
| list |
取得識別提供者的用戶端密碼詳細資料。 |
| update(string, string, string, string, Identity |
更新現有的 IdentityProvider 組態。 |
方法詳細資料
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
建立或更新 IdentityProvider 組態。
function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- identityProviderName
-
string
識別提供者類型識別碼。
- parameters
- IdentityProviderCreateContract
建立參數。
選項參數。
傳回
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
刪除指定的識別提供者組態。
function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- identityProviderName
-
string
識別提供者類型識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, IdentityProviderGetOptionalParams)
取得指定之服務實例中所設定之識別提供者的組態詳細資料。
function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- identityProviderName
-
string
識別提供者類型識別碼。
選項參數。
傳回
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
取得實體狀態 (Etag) 其識別碼所指定的 identityProvider 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- identityProviderName
-
string
識別提供者類型識別碼。
選項參數。
傳回
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
列出指定之服務實例中設定的識別提供者集合。
function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)
取得識別提供者的用戶端密碼詳細資料。
function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- identityProviderName
-
string
識別提供者類型識別碼。
選項參數。
傳回
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
更新現有的 IdentityProvider 組態。
function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- identityProviderName
-
string
識別提供者類型識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
- parameters
- IdentityProviderUpdateParameters
更新參數。
選項參數。
傳回
Promise<IdentityProviderUpdateResponse>