CommunicationIdentityClient class
Azure İletişim Hizmetleri Kullanıcı Belirteci Yönetimi ile etkileşime yönelik istemci sınıfı.
Oluşturucular
| Communication |
CommunicationIdentity sınıfının yeni bir örneğini başlatır. |
| Communication |
Azure KeyCredential kullanarak CommunicationIdentity sınıfının yeni bir örneğini başlatır. |
| Communication |
TokenCredential kullanarak CommunicationIdentity sınıfının yeni bir örneğini başlatır. |
Yöntemler
| create |
Tek bir kullanıcı oluşturur. |
| delete |
Kullanıcı için iptal olayını tetikler ve tüm verilerini siler. |
| issue |
Kapsamlı bir kullanıcı belirteci oluşturur. |
| revoke |
Bir kullanıcı için oluşturulan tüm verileri ve belirteçleri iptal eder. |
Oluşturucu Ayrıntıları
CommunicationIdentityClient(string, CommunicationIdentityOptions)
CommunicationIdentity sınıfının yeni bir örneğini başlatır.
new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityOptions)Parametreler
- connectionString
-
string
Azure İletişim Hizmeti kaynağına bağlanmak için bağlantı dizesi. Örnek: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";
- options
- CommunicationIdentityOptions
Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityOptions)
Azure KeyCredential kullanarak CommunicationIdentity sınıfının yeni bir örneğini başlatır.
new CommunicationIdentityClient(url: string, credential: KeyCredential, options?: CommunicationIdentityOptions)Parametreler
- url
-
string
Hizmetin uç noktası (ör. https://contoso.eastus.communications.azure.net).
- credential
- KeyCredential
Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan bir nesne. Kimlik bilgisi oluşturmak için AzureKeyCredential veya @azure/identity kullanın.
- options
- CommunicationIdentityOptions
Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityOptions)
TokenCredential kullanarak CommunicationIdentity sınıfının yeni bir örneğini başlatır.
new CommunicationIdentityClient(url: string, credential: TokenCredential, options?: CommunicationIdentityOptions)Parametreler
- url
-
string
Hizmetin uç noktası (örn: https://contoso.eastus.communications.azure.net)
- credential
- TokenCredential
Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan TokenCredential.
- options
- CommunicationIdentityOptions
Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.
Yöntem Ayrıntıları
createUser(OperationOptions)
Tek bir kullanıcı oluşturur.
function createUser(options?: OperationOptions): Promise<CreateUserResponse>Parametreler
- options
- OperationOptions
İstek için ek seçenekler.
Döndürülenler
Promise<CreateUserResponse>
deleteUser(CommunicationUserIdentifier, OperationOptions)
Kullanıcı için iptal olayını tetikler ve tüm verilerini siler.
function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<{ _response: HttpResponse }>Parametreler
Silinen kullanıcı.
- options
- OperationOptions
İstek için ek seçenekler.
Döndürülenler
Promise<{ _response: HttpResponse }>
issueToken(CommunicationUserIdentifier, TokenScope[], OperationOptions)
Kapsamlı bir kullanıcı belirteci oluşturur.
function issueToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: OperationOptions): Promise<IssueTokenResponse>Parametreler
Belirteçleri iptal edilen kullanıcı.
- scopes
Belirteçte eklenecek kapsamlar.
- options
- OperationOptions
İstek için ek seçenekler.
Döndürülenler
Promise<IssueTokenResponse>
revokeTokens(CommunicationUserIdentifier, Date, OperationOptions)
Bir kullanıcı için oluşturulan tüm verileri ve belirteçleri iptal eder.
function revokeTokens(user: CommunicationUserIdentifier, tokensValidFrom?: Date, options?: OperationOptions): Promise<{ _response: HttpResponse }>Parametreler
Belirteçleri iptal edilen kullanıcı.
- tokensValidFrom
-
Date
Bu süreden önce verilen jetonlar iptal edilecektir.
- options
- OperationOptions
İstek için ek seçenekler.
Döndürülenler
Promise<{ _response: HttpResponse }>
