Поделиться через

GroupUser interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

Интерфейс, представляющий GroupUser.

Методы

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

Проверяет, связана ли сущность пользователя, указанная идентификатором, с сущностью группы.
create(string, string, string, string, GroupUserCreateOptionalParams)

Добавляет существующего пользователя в существующий продукт.
delete(string, string, string, string, GroupUserDeleteOptionalParams)

Удаляет пользователя из существующей группы.
list(string, string, string, GroupUserListOptionalParams)

Возвращает коллекцию сущностей пользователей, связанных с группой.

Сведения о методе

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.

options
GroupUserCheckEntityExistsOptionalParams

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>