CommunicationIdentityClient class
Classe de cliente para interagir com o Gerenciamento de Token de Usuário dos Serviços de Comunicação do Azure.
Construtores
| Communication |
Inicializa uma nova instância da classe CommunicationIdentity. |
| Communication |
Inicializa uma nova instância da classe CommunicationIdentity usando uma KeyCredential do Azure. |
| Communication |
Inicializa uma nova instância da classe CommunicationIdentity usando um TokenCredential. |
Métodos
| create |
Cria um único usuário. |
| delete |
Aciona o evento de revogação para o usuário e exclui todos os seus dados. |
| issue |
Cria um token de usuário com escopo. |
| revoke |
Revoga todos os dados e tokens criados para um usuário. |
Detalhes do Construtor
CommunicationIdentityClient(string, CommunicationIdentityOptions)
Inicializa uma nova instância da classe CommunicationIdentity.
new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityOptions)Parâmetros
- connectionString
-
string
Cadeia de conexão para se conectar a um recurso do Serviço de Comunicação do Azure. Exemplo: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";
- options
- CommunicationIdentityOptions
Opcional. Opções para configurar o pipeline HTTP.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityOptions)
Inicializa uma nova instância da classe CommunicationIdentity usando uma KeyCredential do Azure.
new CommunicationIdentityClient(url: string, credential: KeyCredential, options?: CommunicationIdentityOptions)Parâmetros
- url
-
string
O ponto de extremidade do serviço (por exemplo: https://contoso.eastus.communications.azure.net).
- credential
- KeyCredential
Um objeto que é usado para autenticar solicitações para o serviço. Use o AzureKeyCredential ou @azure/identity para criar uma credencial.
- options
- CommunicationIdentityOptions
Opcional. Opções para configurar o pipeline HTTP.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityOptions)
Inicializa uma nova instância da classe CommunicationIdentity usando um TokenCredential.
new CommunicationIdentityClient(url: string, credential: TokenCredential, options?: CommunicationIdentityOptions)Parâmetros
- url
-
string
O ponto de extremidade do serviço (por exemplo: https://contoso.eastus.communications.azure.net)
- credential
- TokenCredential
TokenCredential que é usado para autenticar solicitações para o serviço.
- options
- CommunicationIdentityOptions
Opcional. Opções para configurar o pipeline HTTP.
Detalhes de Método
createUser(OperationOptions)
Cria um único usuário.
function createUser(options?: OperationOptions): Promise<CreateUserResponse>Parâmetros
- options
- OperationOptions
Opções adicionais para o pedido.
Devoluções
Promise<CreateUserResponse>
deleteUser(CommunicationUserIdentifier, OperationOptions)
Aciona o evento de revogação para o usuário e exclui todos os seus dados.
function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<{ _response: HttpResponse }>Parâmetros
O usuário que está sendo excluído.
- options
- OperationOptions
Opções adicionais para o pedido.
Devoluções
Promise<{ _response: HttpResponse }>
issueToken(CommunicationUserIdentifier, TokenScope[], OperationOptions)
Cria um token de usuário com escopo.
function issueToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: OperationOptions): Promise<IssueTokenResponse>Parâmetros
O usuário cujos tokens estão sendo revogados.
- scopes
Escopos a serem incluídos no token.
- options
- OperationOptions
Opções adicionais para o pedido.
Devoluções
Promise<IssueTokenResponse>
revokeTokens(CommunicationUserIdentifier, Date, OperationOptions)
Revoga todos os dados e tokens criados para um usuário.
function revokeTokens(user: CommunicationUserIdentifier, tokensValidFrom?: Date, options?: OperationOptions): Promise<{ _response: HttpResponse }>Parâmetros
O usuário cujos tokens estão sendo revogados.
- tokensValidFrom
-
Date
Os tokens emitidos antes deste período serão revogados.
- options
- OperationOptions
Opções adicionais para o pedido.
Devoluções
Promise<{ _response: HttpResponse }>
