Compartir a través de

GroupUser interface

  • Referencia
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 el identificador está asociada a la entidad de grupo.
create(string, string, string, string, GroupUserCreateOptionalParams)

Agrega un usuario existente a un grupo que ya existe
delete(string, string, string, string, GroupUserDeleteOptionalParams)

Elimina un usuario existente de un grupo que ya existe.
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 el 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 distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

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

userId

string

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

options
GroupUserCheckEntityExistsOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupUserCheckEntityExistsResponse>

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

Agrega un usuario existente a un grupo que ya existe

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 distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

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

userId

string

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

options
GroupUserCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserContract>

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

Elimina un usuario existente de un grupo que ya existe.

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 distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

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

userId

string

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

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 distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

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

options
GroupUserListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>