Package version:

Class SipRoutingClient

Client class for interacting with Azure Communication Services SIP Routing Administration.

Hierarchy

SipRoutingClient

Index

Constructors

constructor

Methods

deleteTrunk getRoutes getTrunk getTrunks setRoutes setTrunk setTrunks

Constructors

constructor

new SipRoutingClient(connectionString: string, options?: SipRoutingClientOptions): SipRoutingClient
Initializes a new instance of the SipRoutingClient class using a connection string.
Parameters
- connectionString: string
  
  Connection string to connect to an Azure Communication Service resource. (eg: endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret)
- Optional options: SipRoutingClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns SipRoutingClient
- Defined in sipRoutingClient.ts:49
new SipRoutingClient(endpoint: string, credential: KeyCredential, options?: SipRoutingClientOptions): SipRoutingClient
Initializes a new instance of the SipRoutingClient class using an Azure KeyCredential.
Parameters
- endpoint: string
  
  The endpoint of the service (eg: https://contoso.eastus.communications.azure.net).
- credential: KeyCredential
  
  An object that is used to authenticate requests to the service. Use the Azure KeyCredential or @azure/identity to create a credential.
- Optional options: SipRoutingClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns SipRoutingClient
- Defined in sipRoutingClient.ts:58
new SipRoutingClient(endpoint: string, credential: TokenCredential, options?: SipRoutingClientOptions): SipRoutingClient
Initializes a new instance of the SipRoutingClient class using a TokenCredential.
Parameters
- endpoint: string
  
  The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
- credential: TokenCredential
  
  TokenCredential that is used to authenticate requests to the service.
- Optional options: SipRoutingClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns SipRoutingClient
- Defined in sipRoutingClient.ts:70

Methods

deleteTrunk

deleteTrunk(fqdn: string, options?: OperationOptions): Promise<void>
Deletes the SIP trunk.
Parameters
- fqdn: string
  
  The trunk's FQDN.
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<void>
- Defined in sipRoutingClient.ts:225

getRoutes

getRoutes(options?: OperationOptions): Promise<SipTrunkRoute[]>
Gets the SIP trunk routes.
Parameters
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<SipTrunkRoute[]>
- Defined in sipRoutingClient.ts:133

getTrunk

getTrunk(fqdn: string, options?: OperationOptions): Promise<SipTrunk>
Gets the SIP trunk.
Parameters
- fqdn: string
  
  The trunk's FQDN.
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<SipTrunk>
- Defined in sipRoutingClient.ts:117

getTrunks

getTrunks(options?: OperationOptions): Promise<SipTrunk[]>
Gets the SIP trunks.
Parameters
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<SipTrunk[]>
- Defined in sipRoutingClient.ts:105

setRoutes

setRoutes(routes: SipTrunkRoute[], options?: OperationOptions): Promise<SipTrunkRoute[]>
Sets the SIP trunk routes.
Parameters
- routes: SipTrunkRoute[]
  
  The SIP trunk routes to be set.
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<SipTrunkRoute[]>
- Defined in sipRoutingClient.ts:202

setTrunk

setTrunk(trunk: SipTrunk, options?: OperationOptions): Promise<SipTrunk>
Sets the SIP trunk.
Parameters
- trunk: SipTrunk
  
  The SIP trunk to be set.
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<SipTrunk>
- Defined in sipRoutingClient.ts:176

setTrunks

setTrunks(trunks: SipTrunk[], options?: OperationOptions): Promise<SipTrunk[]>
Sets the SIP trunks.
Parameters
- trunks: SipTrunk[]
  
  The SIP trunks to be set.
- options: OperationOptions = {}
  
  The options parameters.
Returns Promise<SipTrunk[]>
- Defined in sipRoutingClient.ts:145

Class SipRoutingClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connectionString: string

Optional options: SipRoutingClientOptions

Returns SipRoutingClient

Parameters

endpoint: string

credential: KeyCredential

Optional options: SipRoutingClientOptions

Returns SipRoutingClient

Parameters

endpoint: string

credential: TokenCredential

Optional options: SipRoutingClientOptions

Returns SipRoutingClient

Methods

deleteTrunk

Parameters

fqdn: string

options: OperationOptions = {}

Returns Promise<void>

getRoutes

Parameters

options: OperationOptions = {}

Returns Promise<SipTrunkRoute[]>

getTrunk

Parameters

fqdn: string

options: OperationOptions = {}

Returns Promise<SipTrunk>

getTrunks

Parameters

options: OperationOptions = {}

Returns Promise<SipTrunk[]>

setRoutes

Parameters

routes: SipTrunkRoute[]

options: OperationOptions = {}

Returns Promise<SipTrunkRoute[]>

setTrunk

Parameters

trunk: SipTrunk

options: OperationOptions = {}

Returns Promise<SipTrunk>

setTrunks

Parameters

trunks: SipTrunk[]

options: OperationOptions = {}

Returns Promise<SipTrunk[]>

Settings

Member Visibility

Theme

`Optional` options: SipRoutingClientOptions

`Optional` options: SipRoutingClientOptions

`Optional` options: SipRoutingClientOptions