GroupUser interface
GroupUser を表すインターフェイス。
メソッド
| check |
識別子で指定されたユーザー エンティティがグループ エンティティに関連付けられていることを確認します。 |
| create(string, string, string, string, Group |
既存のユーザーを既存のグループに追加します。 |
| delete(string, string, string, string, Group |
既存のグループから既存のユーザーを削除します。 |
| list(string, string, string, Group |
グループに関連付けられているユーザー エンティティのコレクションを一覧表示します。 |
メソッドの詳細
checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)
識別子で指定されたユーザー エンティティがグループ エンティティに関連付けられていることを確認します。
function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<GroupUserCheckEntityExistsResponse>
create(string, string, string, string, GroupUserCreateOptionalParams)
既存のユーザーを既存のグループに追加します。
function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- GroupUserCreateOptionalParams
options パラメーター。
戻り値
Promise<UserContract>
delete(string, string, string, string, GroupUserDeleteOptionalParams)
既存のグループから既存のユーザーを削除します。
function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- GroupUserDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
list(string, string, string, GroupUserListOptionalParams)
グループに関連付けられているユーザー エンティティのコレクションを一覧表示します。
function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- GroupUserListOptionalParams
options パラメーター。