OpenIdConnectProvider interface
OpenIdConnectProvider を表すインターフェイス。
メソッド
| create |
OpenID Connect プロバイダーを作成または更新します。 |
| delete(string, string, string, string, Open |
API Management サービス インスタンスの特定の OpenID Connect プロバイダーを削除します。 |
| get(string, string, string, Open |
シークレットのない特定の OpenID Connect プロバイダーを取得します。 |
| get |
識別子で指定された openIdConnectProvider のエンティティ状態 (Etag) バージョンを取得します。 |
| 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 Management サービスの名前。
- opid
-
string
OpenID Connect プロバイダーの識別子。
- parameters
- OpenidConnectProviderContract
パラメーターを作成します。
options パラメーター。
戻り値
delete(string, string, string, string, OpenIdConnectProviderDeleteOptionalParams)
API Management サービス インスタンスの特定の OpenID Connect プロバイダーを削除します。
function delete(resourceGroupName: string, serviceName: string, opid: string, ifMatch: string, options?: OpenIdConnectProviderDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- opid
-
string
OpenID Connect プロバイダーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
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 Management サービスの名前。
- opid
-
string
OpenID Connect プロバイダーの識別子。
options パラメーター。
戻り値
Promise<OpenIdConnectProviderGetResponse>
getEntityTag(string, string, string, OpenIdConnectProviderGetEntityTagOptionalParams)
識別子で指定された openIdConnectProvider のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetEntityTagOptionalParams): Promise<OpenIdConnectProviderGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- opid
-
string
OpenID Connect プロバイダーの識別子。
options パラメーター。
戻り値
listByService(string, string, OpenIdConnectProviderListByServiceOptionalParams)
すべての OpenID Connect プロバイダーを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: OpenIdConnectProviderListByServiceOptionalParams): PagedAsyncIterableIterator<OpenidConnectProviderContract, OpenidConnectProviderContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
listSecrets(string, string, string, OpenIdConnectProviderListSecretsOptionalParams)
OpenID Connect プロバイダーのクライアント シークレットの詳細を取得します。
function listSecrets(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderListSecretsOptionalParams): Promise<OpenIdConnectProviderListSecretsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- opid
-
string
OpenID Connect プロバイダーの識別子。
options パラメーター。
戻り値
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 Management サービスの名前。
- opid
-
string
OpenID Connect プロバイダーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- OpenidConnectProviderUpdateContract
パラメーターを更新します。
options パラメーター。
戻り値
Promise<OpenIdConnectProviderUpdateResponse>