User interface
Interface que representa um Utilizador.
Métodos
Detalhes de Método
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Cria ou Atualizações um utilizador.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- parameters
- UserCreateParameters
Criar ou atualizar parâmetros.
- options
- UserCreateOrUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Elimina um utilizador específico.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): 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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- UserDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Obtém um URL de redirecionamento que contém um token de autenticação para assinar um determinado utilizador no portal do programador.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- UserGenerateSsoUrlOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Obtém os detalhes do utilizador especificados pelo identificador.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- UserGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) do utilizador especificada pelo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- UserGetEntityTagOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Obtém o Token de Autorização de Acesso Partilhado para o Utilizador.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- parameters
- UserTokenParameters
Criar parâmetros do Token de Autorização.
Os parâmetros de opções.
Devoluções
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Lista uma coleção de utilizadores registados na instância de serviço especificada.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): 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.
- options
- UserListByServiceOptionalParams
Os parâmetros de opções.
Devoluções
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Atualizações os detalhes do utilizador especificados pelo identificador.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>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.
- userId
-
string
Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- UserUpdateParameters
Atualizar parâmetros.
- options
- UserUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserUpdateResponse>