AuthorizationServer interface
AuthorizationServer を表すインターフェイス。
メソッド
| create |
新しい承認サーバーを作成するか、既存の承認サーバーを更新します。 |
| delete(string, string, string, string, Authorization |
特定の承認サーバーのインスタンスを削除します。 |
| get(string, string, string, Authorization |
識別子で指定された承認サーバーの詳細を取得します。 |
| get |
識別子で指定された authorizationServer のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
サービス インスタンス内で定義されている承認サーバーのコレクションを一覧表示します。 |
| list |
承認サーバーのクライアント シークレットの詳細を取得します。 |
| update(string, string, string, string, Authorization |
id で指定された承認サーバーの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)
新しい承認サーバーを作成するか、既存の承認サーバーを更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authsid
-
string
承認サーバーの識別子。
- parameters
- AuthorizationServerContract
パラメーターを作成または更新します。
options パラメーター。
戻り値
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)
特定の承認サーバーのインスタンスを削除します。
function delete(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, options?: AuthorizationServerDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authsid
-
string
承認サーバーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, AuthorizationServerGetOptionalParams)
識別子で指定された承認サーバーの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authsid
-
string
承認サーバーの識別子。
options パラメーター。
戻り値
Promise<AuthorizationServerGetResponse>
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)
識別子で指定された authorizationServer のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authsid
-
string
承認サーバーの識別子。
options パラメーター。
戻り値
listByService(string, string, AuthorizationServerListByServiceOptionalParams)
サービス インスタンス内で定義されている承認サーバーのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)
承認サーバーのクライアント シークレットの詳細を取得します。
function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authsid
-
string
承認サーバーの識別子。
options パラメーター。
戻り値
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)
id で指定された承認サーバーの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- authsid
-
string
承認サーバーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- AuthorizationServerUpdateContract
OAuth2 サーバー設定パラメーターを更新します。
options パラメーター。
戻り値
Promise<AuthorizationServerUpdateResponse>