GroupUser interface
Interface que representa um GroupUser.
Métodos
| check |
Verifica se a entidade de utilizador especificada pelo identificador está associada à entidade de grupo. |
| create(string, string, string, string, Group |
Adicionar utilizador existente ao grupo existente |
| delete(string, string, string, string, Group |
Remover utilizador existente do grupo existente. |
| list(string, string, string, Group |
Lista uma coleção de entidades de utilizador associadas ao grupo. |
Detalhes de Método
checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)
Verifica se a entidade de utilizador especificada pelo identificador está associada à entidade de 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<GroupUserCheckEntityExistsResponse>
create(string, string, string, string, GroupUserCreateOptionalParams)
Adicionar utilizador 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- GroupUserCreateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserContract>
delete(string, string, string, string, GroupUserDeleteOptionalParams)
Remover utilizador 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço do Gestão 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 utilizador 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- GroupUserListOptionalParams
Os parâmetros de opções.