Authorization interface
承認を表すインターフェイス。
メソッド
| confirm |
有効な同意コードを確認して、承認フィッシング対策ページを抑制します。 |
| create |
承認を作成または更新します。 |
| delete(string, string, string, string, string, Authorization |
承認プロバイダーから特定の承認を削除します。 |
| get(string, string, string, string, Authorization |
識別子で指定された承認の詳細を取得します。 |
| list |
承認プロバイダー内で定義されている承認プロバイダーのコレクションを一覧表示します。 |
メソッドの詳細
confirmConsentCode(string, string, string, string, AuthorizationConfirmConsentCodeRequestContract, AuthorizationConfirmConsentCodeOptionalParams)
有効な同意コードを確認して、承認フィッシング対策ページを抑制します。
function confirmConsentCode(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, parameters: AuthorizationConfirmConsentCodeRequestContract, options?: AuthorizationConfirmConsentCodeOptionalParams): Promise<AuthorizationConfirmConsentCodeHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authorizationProviderId
-
string
承認プロバイダーの識別子。
- authorizationId
-
string
承認の識別子。
パラメーターを作成します。
options パラメーター。
戻り値
createOrUpdate(string, string, string, string, AuthorizationContract, AuthorizationCreateOrUpdateOptionalParams)
承認を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, parameters: AuthorizationContract, options?: AuthorizationCreateOrUpdateOptionalParams): Promise<AuthorizationCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authorizationProviderId
-
string
承認プロバイダーの識別子。
- authorizationId
-
string
承認の識別子。
- parameters
- AuthorizationContract
パラメーターを作成します。
options パラメーター。
戻り値
Promise<AuthorizationCreateOrUpdateResponse>
delete(string, string, string, string, string, AuthorizationDeleteOptionalParams)
承認プロバイダーから特定の承認を削除します。
function delete(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, ifMatch: string, options?: AuthorizationDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authorizationProviderId
-
string
承認プロバイダーの識別子。
- authorizationId
-
string
承認の識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, AuthorizationGetOptionalParams)
識別子で指定された承認の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, options?: AuthorizationGetOptionalParams): Promise<AuthorizationGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authorizationProviderId
-
string
承認プロバイダーの識別子。
- authorizationId
-
string
承認の識別子。
- options
- AuthorizationGetOptionalParams
options パラメーター。
戻り値
Promise<AuthorizationGetResponse>
listByAuthorizationProvider(string, string, string, AuthorizationListByAuthorizationProviderOptionalParams)
承認プロバイダー内で定義されている承認プロバイダーのコレクションを一覧表示します。
function listByAuthorizationProvider(resourceGroupName: string, serviceName: string, authorizationProviderId: string, options?: AuthorizationListByAuthorizationProviderOptionalParams): PagedAsyncIterableIterator<AuthorizationContract, AuthorizationContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authorizationProviderId
-
string
承認プロバイダーの識別子。
options パラメーター。