Class CommunicationRelayClient

constructor

• new CommunicationRelayClient(connectionString: string, options?: CommunicationRelayClientOptions): CommunicationRelayClient
• new CommunicationRelayClient(endpoint: string, credential: KeyCredential, options?: CommunicationRelayClientOptions): CommunicationRelayClient
• new CommunicationRelayClient(endpoint: string, credential: TokenCredential, options?: CommunicationRelayClientOptions): CommunicationRelayClient

• Initializes a new instance of the CommunicationRelayClient class.

  Parameters

  • connectionString: string

    Connection string to connect to an Azure Communication Service resource. Example: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";

  • Optional options: CommunicationRelayClientOptions

    Optional. Options to configure the HTTP pipeline.

  Returns CommunicationRelayClient

• Initializes a new instance of the CommunicationRelayClient class using an Azure KeyCredential.

  Parameters

  • endpoint: string

    The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).

  • credential: KeyCredential

    An object that is used to authenticate requests to the service. Use the AzureKeyCredential or @azure/identity to create a credential.

  • Optional options: CommunicationRelayClientOptions

    Optional. Options to configure the HTTP pipeline.

  Returns CommunicationRelayClient

• Initializes a new instance of the CommunicationRelayClient class using a TokenCredential.

  Parameters

  • endpoint: string

    The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).

  • credential: TokenCredential

    An object that is used to authenticate requests to the service. Use the AzureKeyCredential or @azure/identity to create a credential.

  • Optional options: CommunicationRelayClientOptions

    Optional. Options to configure the HTTP pipeline.

  Returns CommunicationRelayClient