IdentityProvider interface
IdentityProvider を表すインターフェイス。
メソッド
| create |
IdentityProvider 構成を作成または更新します。 |
| delete(string, string, string, string, Identity |
指定された ID プロバイダーの構成を削除します。 |
| get(string, string, string, Identity |
指定したサービス インスタンスで構成された ID プロバイダーの構成の詳細を取得します。 |
| get |
識別子で指定された identityProvider のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定されたサービス インスタンスで構成されている ID プロバイダーのコレクションを一覧表示します。 |
| list |
ID プロバイダーのクライアント シークレットの詳細を取得します。 |
| 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 Management サービスの名前。
- identityProviderName
-
string
ID プロバイダーの種類識別子。
- parameters
- IdentityProviderCreateContract
パラメーターを作成します。
options パラメーター。
戻り値
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
指定された ID プロバイダーの構成を削除します。
function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- identityProviderName
-
string
ID プロバイダーの種類識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, IdentityProviderGetOptionalParams)
指定したサービス インスタンスで構成された ID プロバイダーの構成の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- identityProviderName
-
string
ID プロバイダーの種類識別子。
options パラメーター。
戻り値
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
識別子で指定された identityProvider のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- identityProviderName
-
string
ID プロバイダーの種類識別子。
options パラメーター。
戻り値
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
指定されたサービス インスタンスで構成されている ID プロバイダーのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)
ID プロバイダーのクライアント シークレットの詳細を取得します。
function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- identityProviderName
-
string
ID プロバイダーの種類識別子。
options パラメーター。
戻り値
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 Management サービスの名前。
- identityProviderName
-
string
ID プロバイダーの種類識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- IdentityProviderUpdateParameters
パラメーターを更新します。
options パラメーター。
戻り値
Promise<IdentityProviderUpdateResponse>