DeviceNetwork.RetrieveAsync Method

Definition

Namespace:

Azure.Communication.ProgrammableConnectivity

Assembly:

Azure.Communication.ProgrammableConnectivity.dll

Package:

Azure.Communication.ProgrammableConnectivity v1.0.0-beta.1

Overloads

RetrieveAsync(String, NetworkIdentifier, CancellationToken)	Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.
RetrieveAsync(String, RequestContent, RequestContext)	[Protocol Method] Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler RetrieveAsync(String, NetworkIdentifier, CancellationToken) convenience overload with strongly typed models first.

RetrieveAsync(String, NetworkIdentifier, CancellationToken)

Source:

DeviceNetwork.cs

Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.ProgrammableConnectivity.NetworkRetrievalResult>> RetrieveAsync (string apcGatewayId, Azure.Communication.ProgrammableConnectivity.NetworkIdentifier networkIdentifier, System.Threading.CancellationToken cancellationToken = default);

abstract member RetrieveAsync : string * Azure.Communication.ProgrammableConnectivity.NetworkIdentifier * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.ProgrammableConnectivity.NetworkRetrievalResult>>
override this.RetrieveAsync : string * Azure.Communication.ProgrammableConnectivity.NetworkIdentifier * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.ProgrammableConnectivity.NetworkRetrievalResult>>

Public Overridable Function RetrieveAsync (apcGatewayId As String, networkIdentifier As NetworkIdentifier, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of NetworkRetrievalResult))

Parameters

apcGatewayId

String

The identifier of the APC Gateway resource which should handle this request.

networkIdentifier

NetworkIdentifier

Identifier for the network to be queried.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<NetworkRetrievalResult>>

Exceptions

ArgumentNullException

apcGatewayId or networkIdentifier is null.

Examples

This sample shows how to call RetrieveAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeviceNetwork client = new ProgrammableConnectivityClient(endpoint, credential).GetDeviceNetworkClient(apiVersion: "2024-02-09-preview");

NetworkIdentifier networkIdentifier = new NetworkIdentifier("<identifierType>", "<identifier>");
Response<NetworkRetrievalResult> response = await client.RetrieveAsync("<apcGatewayId>", networkIdentifier);

This sample shows how to call RetrieveAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeviceNetwork client = new ProgrammableConnectivityClient(endpoint, credential).GetDeviceNetworkClient(apiVersion: "2024-02-09-preview");

NetworkIdentifier networkIdentifier = new NetworkIdentifier("<identifierType>", "<identifier>");
Response<NetworkRetrievalResult> response = await client.RetrieveAsync("<apcGatewayId>", networkIdentifier);

RetrieveAsync(String, RequestContent, RequestContext)

Source:

DeviceNetwork.cs

[Protocol Method] Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler RetrieveAsync(String, NetworkIdentifier, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> RetrieveAsync (string apcGatewayId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member RetrieveAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RetrieveAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function RetrieveAsync (apcGatewayId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

apcGatewayId

String

The identifier of the APC Gateway resource which should handle this request.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

apcGatewayId or content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call RetrieveAsync and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeviceNetwork client = new ProgrammableConnectivityClient(endpoint, credential).GetDeviceNetworkClient(apiVersion: "2024-02-09-preview");

using RequestContent content = RequestContent.Create(new
{
    identifierType = "<identifierType>",
    identifier = "<identifier>",
});
Response response = await client.RetrieveAsync("<apcGatewayId>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("networkCode").ToString());

This sample shows how to call RetrieveAsync with all parameters and request content and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeviceNetwork client = new ProgrammableConnectivityClient(endpoint, credential).GetDeviceNetworkClient(apiVersion: "2024-02-09-preview");

using RequestContent content = RequestContent.Create(new
{
    identifierType = "<identifierType>",
    identifier = "<identifier>",
});
Response response = await client.RetrieveAsync("<apcGatewayId>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("networkCode").ToString());