WorkspaceGroupUser interface
Interface representing a WorkspaceGroupUser.
Methods
| check |
Checks that user entity specified by identifier is associated with the group entity. |
| create(string, string, string, string, string, Workspace |
Add existing user to existing group |
| delete(string, string, string, string, string, Workspace |
Remove existing user from existing group. |
| list(string, string, string, string, Workspace |
Lists a collection of user entities associated with the group. |
Method Details
checkEntityExists(string, string, string, string, string, WorkspaceGroupUserCheckEntityExistsOptionalParams)
Checks that user entity specified by identifier is associated with the group entity.
function checkEntityExists(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, userId: string, options?: WorkspaceGroupUserCheckEntityExistsOptionalParams): Promise<WorkspaceGroupUserCheckEntityExistsResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
create(string, string, string, string, string, WorkspaceGroupUserCreateOptionalParams)
Add existing user to existing group
function create(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, userId: string, options?: WorkspaceGroupUserCreateOptionalParams): Promise<UserContract>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<UserContract>
delete(string, string, string, string, string, WorkspaceGroupUserDeleteOptionalParams)
Remove existing user from existing group.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, userId: string, options?: WorkspaceGroupUserDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<void>
list(string, string, string, string, WorkspaceGroupUserListOptionalParams)
Lists a collection of user entities associated with the group.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
The options parameters.