Sample_SipRoutingClientAsync.md

Managing SIP routing configuration

This sample demonstrates how to retrieve and manage SIP routing configuration for Azure Communication resources. To get started, you'll need a URI to an Azure Communication Services resource. See the README for links and instructions.

Creating a SipRoutingClient

To create a new SipRoutingClient you need a connection string to the Azure Communication Services resource that you can get from the Azure Portal once you have created the resource.

You can set connectionString as an environment variable, a configuration setting, or any way that works for your application.

// Get a connection string to Azure Communication resource.
var connectionString = "<connection_string>";
var client = new SipRoutingClient(connectionString);

Operations on collections

To retrieve or replace current Trunk or Route configuration, SDK provides several functions that operate on the whole collection.

Set SIP configuration

Set SIP trunks and routes in bulk.

// The service will not allow trunks that are used in any of the routes to be deleted, therefore first set the routes as empty list, and then update the routes.
var newTrunks = "<new_trunks_list>";
var newRoutes = "<new_routes_list>";
await client.SetRoutesAsync(new List<SipTrunkRoute>());
await client.SetTrunksAsync(newTrunks);
await client.SetRoutesAsync(newRoutes);

Retrieve SIP configuration

var trunksResponse = await client.GetTrunksAsync();
var routesResponse = await client.GetRoutesAsync();

Operations on a single trunk

The SDK allows also for retrieving, setting and deleting single item from the collection.

Retrieve single item

// Get trunk object, based on it's FQDN.
var fqdnToRetrieve = "<fqdn>";
var trunkResponse = await client.GetTrunkAsync(fqdnToRetrieve);

Set single item

// Set function will either modify existing item or add new item to the collection.
// The trunk is matched based on it's FQDN.
var trunkToSet = "<trunk_to_set>";
await client.SetTrunkAsync(trunkToSet);

Delete single item

// Deletes trunk with supplied FQDN.
var fqdnToDelete = "<fqdn>";
await client.DeleteTrunkAsync(fqdnToDelete);