EasmClient.ValidateDataConnectionAsync Method

Definition

Namespace:

Azure.Analytics.Defender.Easm

Assembly:

Azure.Analytics.Defender.Easm.dll

Package:

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

Overloads

ValidateDataConnectionAsync(DataConnectionPayload, CancellationToken)	Validate a data connection with a given dataConnectionName.
ValidateDataConnectionAsync(RequestContent, RequestContext)	[Protocol Method] Validate 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 ValidateDataConnectionAsync(DataConnectionPayload, CancellationToken) convenience overload with strongly typed models first.

ValidateDataConnectionAsync(DataConnectionPayload, CancellationToken)

Source:

EasmClient.cs

Validate a data connection with a given dataConnectionName.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>> ValidateDataConnectionAsync(Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, System.Threading.CancellationToken cancellationToken = default);

abstract member ValidateDataConnectionAsync : Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>>
override this.ValidateDataConnectionAsync : Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>>

Public Overridable Function ValidateDataConnectionAsync (dataConnectionPayload As DataConnectionPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ValidateResult))

Parameters

dataConnectionPayload

DataConnectionPayload

The DataConnectionPayload to use.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ValidateResult>>

Exceptions

ArgumentNullException

dataConnectionPayload is null.

Examples

This sample shows how to call ValidateDataConnectionAsync.

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

DataConnectionPayload dataConnectionPayload = new LogAnalyticsDataConnectionPayload(new LogAnalyticsDataConnectionProperties());
Response<ValidateResult> response = await client.ValidateDataConnectionAsync(dataConnectionPayload);

This sample shows how to call ValidateDataConnectionAsync with all parameters.

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

DataConnectionPayload dataConnectionPayload = new LogAnalyticsDataConnectionPayload(new LogAnalyticsDataConnectionProperties
{
    ApiKey = "<apiKey>",
    WorkspaceId = "<workspaceId>",
})
{
    Name = "<name>",
    Content = DataConnectionContent.Assets,
    Frequency = DataConnectionFrequency.Daily,
    FrequencyOffset = 1234,
};
Response<ValidateResult> response = await client.ValidateDataConnectionAsync(dataConnectionPayload);

ValidateDataConnectionAsync(RequestContent, RequestContext)

Source:

EasmClient.cs

[Protocol Method] Validate 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 ValidateDataConnectionAsync(DataConnectionPayload, CancellationToken) convenience overload with strongly typed models first.

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

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

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

Parameters

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

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

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

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

using RequestContent content = RequestContent.Create(new
{
    properties = new object(),
    kind = "logAnalytics",
});
Response response = await client.ValidateDataConnectionAsync(content);

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

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

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

using RequestContent content = RequestContent.Create(new
{
    properties = new
    {
        apiKey = "<apiKey>",
        workspaceId = "<workspaceId>",
    },
    kind = "logAnalytics",
    name = "<name>",
    content = "assets",
    frequency = "daily",
    frequencyOffset = 1234,
});
Response response = await client.ValidateDataConnectionAsync(content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("value").ToString());