EasmClient.GetDiscoveryGroupRuns Method

Definition

Namespace:

Azure.Analytics.Defender.Easm

Assembly:

Azure.Analytics.Defender.Easm.dll

Package:

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

Overloads

GetDiscoveryGroupRuns(String, String, Nullable<Int32>, Nullable<Int32>, RequestContext)	[Protocol Method] Retrieve a collection of discovery run results for a discovery group with a given groupName. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDiscoveryGroupRuns(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetDiscoveryGroupRuns(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Retrieve a collection of discovery run results for a discovery group with a given groupName.

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

Source:

EasmClient.cs

[Protocol Method] Retrieve a collection of discovery run results for a discovery group with a given groupName.

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

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

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

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

Parameters

groupName

String

The unique identifier for the discovery group.

filter

String

Filter the result list using the given expression.

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

ArgumentNullException

groupName is null.

ArgumentException

groupName 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 GetDiscoveryGroupRuns 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.GetDiscoveryGroupRuns("<groupName>", null, null, null, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetDiscoveryGroupRuns 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.GetDiscoveryGroupRuns("<groupName>", "<filter>", 1234, 1234, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("submittedDate").ToString());
    Console.WriteLine(result.GetProperty("startedDate").ToString());
    Console.WriteLine(result.GetProperty("completedDate").ToString());
    Console.WriteLine(result.GetProperty("tier").ToString());
    Console.WriteLine(result.GetProperty("state").ToString());
    Console.WriteLine(result.GetProperty("totalAssetsFoundCount").ToString());
    Console.WriteLine(result.GetProperty("seeds")[0].GetProperty("kind").ToString());
    Console.WriteLine(result.GetProperty("seeds")[0].GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("excludes")[0].GetProperty("kind").ToString());
    Console.WriteLine(result.GetProperty("excludes")[0].GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("names")[0].ToString());
}

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

Source:

EasmClient.cs

Retrieve a collection of discovery run results for a discovery group with a given groupName.

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

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

Public Overridable Function GetDiscoveryGroupRuns (groupName As String, Optional filter 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 DiscoveryRunResult)

Parameters

groupName

String

The unique identifier for the discovery group.

filter

String

Filter the result list using the given expression.

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<DiscoveryRunResult>

Exceptions

ArgumentNullException

groupName is null.

ArgumentException

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

Examples

This sample shows how to call GetDiscoveryGroupRuns.

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

foreach (DiscoveryRunResult item in client.GetDiscoveryGroupRuns("<groupName>"))
{
}

This sample shows how to call GetDiscoveryGroupRuns with all parameters.

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

foreach (DiscoveryRunResult item in client.GetDiscoveryGroupRuns("<groupName>", filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}