GroupUser interface

Pacote:

@azure/arm-apimanagement

Interface que representa um GroupUser.

Métodos

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)	Verifica se a entidade de usuário especificada pelo identificador está associada à entidade do grupo.
create(string, string, string, string, GroupUserCreateOptionalParams)	Adicionar usuário existente ao grupo existente
delete(string, string, string, string, GroupUserDeleteOptionalParams)	Remova o usuário existente do grupo existente.
list(string, string, string, GroupUserListOptionalParams)	Lista uma coleção de entidades de usuário associadas ao grupo.

Detalhes de Método

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

Verifica se a entidade de usuário especificada pelo identificador está associada à entidade do grupo.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

groupId

string

Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

userId

string

Identificador do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GroupUserCheckEntityExistsOptionalParams

Os parâmetros de opções.

Devoluções

Promise<GroupUserCheckEntityExistsResponse>

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

Adicionar usuário existente ao grupo existente

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

groupId

string

Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

userId

string

Identificador do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GroupUserCreateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<UserContract>

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

Remova o usuário existente do grupo existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

groupId

string

Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

userId

string

Identificador do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GroupUserDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

list(string, string, string, GroupUserListOptionalParams)

Lista uma coleção de entidades de usuário associadas ao grupo.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

groupId

string

Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GroupUserListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>