EasmClient.GetTasks Method

Definition

Namespace:

Azure.Analytics.Defender.Easm

Assembly:

Azure.Analytics.Defender.Easm.dll

Package:

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

Overloads

GetTasks(String, String, Nullable<Int32>, Nullable<Int32>, RequestContext)	[Protocol Method] Retrieve a list of tasks for the provided search parameters. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTasks(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetTasks(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Retrieve a list of tasks for the provided search parameters.

GetTasks(String, String, Nullable<Int32>, Nullable<Int32>, RequestContext)

Source:

EasmClient.cs

[Protocol Method] Retrieve a list of tasks for the provided search parameters.

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

public virtual Azure.Pageable<BinaryData> GetTasks (string filter, string orderby, int? skip, int? maxpagesize, Azure.RequestContext context);

abstract member GetTasks : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTasks : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetTasks (filter As String, orderby As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)

Parameters

filter

String

Filter the result list using the given expression.

orderby

String

A list of expressions that specify the order of the returned resources.

skip

Nullable<Int32>

The number of result items to skip.

maxpagesize

Nullable<Int32>

The maximum number of result items per page.

context

RequestContext

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

Returns

Pageable<BinaryData>

The Pageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

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

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

foreach (BinaryData item in client.GetTasks(null, null, null, null, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("id").ToString());
}

This sample shows how to call GetTasks 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);

foreach (BinaryData item in client.GetTasks("<filter>", "<orderby>", 1234, 1234, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("startedAt").ToString());
    Console.WriteLine(result.GetProperty("completedAt").ToString());
    Console.WriteLine(result.GetProperty("lastPolledAt").ToString());
    Console.WriteLine(result.GetProperty("state").ToString());
    Console.WriteLine(result.GetProperty("phase").ToString());
    Console.WriteLine(result.GetProperty("reason").ToString());
    Console.WriteLine(result.GetProperty("metadata").GetProperty("<key>").ToString());
}

GetTasks(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Source:

EasmClient.cs

Retrieve a list of tasks for the provided search parameters.

public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.TaskResource> GetTasks (string filter = default, string orderby = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetTasks : string * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.TaskResource>
override this.GetTasks : string * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.TaskResource>

Public Overridable Function GetTasks (Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of TaskResource)

Parameters

filter

String

Filter the result list using the given expression.

orderby

String

A list of expressions that specify the order of the returned resources.

skip

Nullable<Int32>

The number of result items to skip.

maxpagesize

Nullable<Int32>

The maximum number of result items per page.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<TaskResource>

Examples

This sample shows how to call GetTasks.

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

foreach (TaskResource item in client.GetTasks())
{
}

This sample shows how to call GetTasks with all parameters.

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

foreach (TaskResource item in client.GetTasks(filter: "<filter>", orderby: "<orderby>", skip: 1234, maxpagesize: 1234))
{
}