Share via

GroupUser interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a GroupUser.

Methods

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)

Checks that user entity specified by identifier is associated with the group entity.
create(string, string, string, string, GroupUserCreateOptionalParams)

Add existing user to existing group
delete(string, string, string, string, GroupUserDeleteOptionalParams)

Remove existing user from existing group.
list(string, string, string, GroupUserListOptionalParams)

Lists a collection of user entities associated with the group.

Method Details

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)

Checks that user entity specified by identifier is associated with the group entity.

function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

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.

options
GroupUserCheckEntityExistsOptionalParams

The options parameters.

Returns

Promise<GroupUserCheckEntityExistsResponse>

create(string, string, string, string, GroupUserCreateOptionalParams)

Add existing user to existing group

function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): 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.

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.

options
GroupUserCreateOptionalParams

The options parameters.

Returns

Promise<UserContract>

delete(string, string, string, string, GroupUserDeleteOptionalParams)

Remove existing user from existing group.

function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): 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.

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.

options
GroupUserDeleteOptionalParams

The options parameters.

Returns

Promise<void>

list(string, string, string, GroupUserListOptionalParams)

Lists a collection of user entities associated with the group.

function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): 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.

groupId

string

Group identifier. Must be unique in the current API Management service instance.

options
GroupUserListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>