GroupUser interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un groupUser.

Métodos

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)	Comprueba que la entidad de usuario especificada por identificador está asociada a la entidad de grupo.
create(string, string, string, string, GroupUserCreateOptionalParams)	Adición de un usuario existente a un grupo existente
delete(string, string, string, string, GroupUserDeleteOptionalParams)	Quite el usuario existente del grupo existente.
list(string, string, string, GroupUserListOptionalParams)	Enumera una colección de entidades de usuario asociadas al grupo.

Detalles del método

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

Comprueba que la entidad de usuario especificada por identificador está asociada a la entidad de grupo.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia actual del servicio API Management.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

options

GroupUserCheckEntityExistsOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupUserCheckEntityExistsResponse>

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

Adición de un usuario existente a un grupo existente

function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia actual del servicio API Management.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

options

GroupUserCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserContract>

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

Quite el usuario existente del grupo existente.

function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia actual del servicio API Management.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

options

GroupUserDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

list(string, string, string, GroupUserListOptionalParams)

Enumera una colección de entidades de usuario asociadas al grupo.

function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia actual del servicio API Management.

options

GroupUserListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>