你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
GroupUser interface
表示 GroupUser 的接口。
方法
方法详细信息
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 管理服务的名称。
- groupId
-
string
组标识符。 当前 API 管理服务实例中必须是唯一的。
- userId
-
string
用户标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
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 管理服务的名称。
- groupId
-
string
组标识符。 当前 API 管理服务实例中必须是唯一的。
- userId
-
string
用户标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- GroupUserCreateOptionalParams
选项参数。
返回
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 管理服务的名称。
- groupId
-
string
组标识符。 当前 API 管理服务实例中必须是唯一的。
- userId
-
string
用户标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- GroupUserDeleteOptionalParams
选项参数。
返回
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 管理服务的名称。
- groupId
-
string
组标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- GroupUserListOptionalParams
选项参数。