EasmClient.GetDataConnection Method

Definition

Namespace:

Azure.Analytics.Defender.Easm

Assembly:

Azure.Analytics.Defender.Easm.dll

Package:

Azure.Analytics.Defender.Easm v1.0.0-beta.1

Overloads

GetDataConnection(String, CancellationToken)	Retrieve a data connection with a given dataConnectionName.
GetDataConnection(String, RequestContext)	[Protocol Method] Retrieve a data connection with a given dataConnectionName. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDataConnection(String, CancellationToken) convenience overload with strongly typed models first.

GetDataConnection(String, CancellationToken)

Source:

EasmClient.cs

Retrieve a data connection with a given dataConnectionName.

public virtual Azure.Response<Azure.Analytics.Defender.Easm.DataConnection> GetDataConnection (string dataConnectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDataConnection : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>
override this.GetDataConnection : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>

Public Overridable Function GetDataConnection (dataConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DataConnection)

Parameters

dataConnectionName

String

The caller provided unique name for the resource.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<DataConnection>

Exceptions

ArgumentNullException

dataConnectionName is null.

ArgumentException

dataConnectionName is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetDataConnection.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);

Response<DataConnection> response = client.GetDataConnection("<dataConnectionName>");

This sample shows how to call GetDataConnection with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);

Response<DataConnection> response = client.GetDataConnection("<dataConnectionName>");

GetDataConnection(String, RequestContext)

Source:

EasmClient.cs

[Protocol Method] Retrieve a data connection with a given dataConnectionName.

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

public virtual Azure.Response GetDataConnection (string dataConnectionName, Azure.RequestContext context);

abstract member GetDataConnection : string * Azure.RequestContext -> Azure.Response
override this.GetDataConnection : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetDataConnection (dataConnectionName As String, context As RequestContext) As Response

Parameters

dataConnectionName

String

The caller provided unique name for the resource.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

dataConnectionName is null.

ArgumentException

dataConnectionName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

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

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);

Response response = client.GetDataConnection("<dataConnectionName>", null);

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

This sample shows how to call GetDataConnection with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);

Response response = client.GetDataConnection("<dataConnectionName>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());