User interface
ユーザーを表すインターフェイス。
メソッド
| create |
ユーザーを作成または更新します。 |
| delete(string, string, string, string, User |
特定のユーザーを削除します。 |
| generate |
特定のユーザーが開発者ポータルにサインインするための認証トークンを含むリダイレクト URL を取得します。 |
| get(string, string, string, User |
識別子で指定されたユーザーの詳細を取得します。 |
| get |
識別子で指定されたユーザーのエンティティ状態 (Etag) バージョンを取得します。 |
| get |
ユーザーの共有アクセス承認トークンを取得します。 |
| list |
指定されたサービス インスタンスにおける登録ユーザーのコレクションを一覧表示します。 |
| update(string, string, string, string, User |
識別子で指定されたユーザーの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
ユーザーを作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- UserCreateParameters
パラメーターを作成または更新します。
- options
- UserCreateOrUpdateOptionalParams
options パラメーター。
戻り値
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
特定のユーザーを削除します。
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- UserDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
特定のユーザーが開発者ポータルにサインインするための認証トークンを含むリダイレクト URL を取得します。
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- UserGenerateSsoUrlOptionalParams
options パラメーター。
戻り値
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
識別子で指定されたユーザーの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- UserGetOptionalParams
options パラメーター。
戻り値
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
識別子で指定されたユーザーのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- UserGetEntityTagOptionalParams
options パラメーター。
戻り値
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
ユーザーの共有アクセス承認トークンを取得します。
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- UserTokenParameters
承認トークン パラメーターを作成します。
options パラメーター。
戻り値
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
指定されたサービス インスタンスにおける登録ユーザーのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- UserListByServiceOptionalParams
options パラメーター。
戻り値
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
識別子で指定されたユーザーの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- UserUpdateParameters
パラメーターを更新します。
- options
- UserUpdateOptionalParams
options パラメーター。
戻り値
Promise<UserUpdateResponse>