OpenIdConnectProvider interface
代表 OpenIdConnectProvider 的介面。
方法
| create |
建立或更新 OpenID Connect 提供者。 |
| delete(string, string, string, string, Open |
刪除API 管理服務實例的特定 OpenID Connect 提供者。 |
| get(string, string, string, Open |
取得不含秘密的特定 OpenID Connect 提供者。 |
| get |
取得實體狀態 (Etag) 其識別碼所指定的 openIdConnectProvider 版本。 |
| list |
所有 OpenId Connect 提供者的清單。 |
| list |
取得 OpenID Connect 提供者的用戶端密碼詳細資料。 |
| update(string, string, string, string, Openid |
更新特定的 OpenID Connect 提供者。 |
方法詳細資料
createOrUpdate(string, string, string, OpenidConnectProviderContract, OpenIdConnectProviderCreateOrUpdateOptionalParams)
建立或更新 OpenID Connect 提供者。
function createOrUpdate(resourceGroupName: string, serviceName: string, opid: string, parameters: OpenidConnectProviderContract, options?: OpenIdConnectProviderCreateOrUpdateOptionalParams): Promise<OpenIdConnectProviderCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- opid
-
string
OpenID Connect 提供者的識別碼。
- parameters
- OpenidConnectProviderContract
建立參數。
選項參數。
傳回
delete(string, string, string, string, OpenIdConnectProviderDeleteOptionalParams)
刪除API 管理服務實例的特定 OpenID Connect 提供者。
function delete(resourceGroupName: string, serviceName: string, opid: string, ifMatch: string, options?: OpenIdConnectProviderDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- opid
-
string
OpenID Connect 提供者的識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, OpenIdConnectProviderGetOptionalParams)
取得不含秘密的特定 OpenID Connect 提供者。
function get(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetOptionalParams): Promise<OpenIdConnectProviderGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- opid
-
string
OpenID Connect 提供者的識別碼。
選項參數。
傳回
Promise<OpenIdConnectProviderGetResponse>
getEntityTag(string, string, string, OpenIdConnectProviderGetEntityTagOptionalParams)
取得實體狀態 (Etag) 其識別碼所指定的 openIdConnectProvider 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetEntityTagOptionalParams): Promise<OpenIdConnectProviderGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- opid
-
string
OpenID Connect 提供者的識別碼。
選項參數。
傳回
listByService(string, string, OpenIdConnectProviderListByServiceOptionalParams)
所有 OpenId Connect 提供者的清單。
function listByService(resourceGroupName: string, serviceName: string, options?: OpenIdConnectProviderListByServiceOptionalParams): PagedAsyncIterableIterator<OpenidConnectProviderContract, OpenidConnectProviderContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
listSecrets(string, string, string, OpenIdConnectProviderListSecretsOptionalParams)
取得 OpenID Connect 提供者的用戶端密碼詳細資料。
function listSecrets(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderListSecretsOptionalParams): Promise<OpenIdConnectProviderListSecretsResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- opid
-
string
OpenID Connect 提供者的識別碼。
選項參數。
傳回
update(string, string, string, string, OpenidConnectProviderUpdateContract, OpenIdConnectProviderUpdateOptionalParams)
更新特定的 OpenID Connect 提供者。
function update(resourceGroupName: string, serviceName: string, opid: string, ifMatch: string, parameters: OpenidConnectProviderUpdateContract, options?: OpenIdConnectProviderUpdateOptionalParams): Promise<OpenIdConnectProviderUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- opid
-
string
OpenID Connect 提供者的識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
- parameters
- OpenidConnectProviderUpdateContract
更新參數。
選項參數。
傳回
Promise<OpenIdConnectProviderUpdateResponse>