EasmClient.GetDiscoveryGroups Method

  • Reference

Definition

Namespace:
Azure.Analytics.Defender.Easm
Assembly:
Azure.Analytics.Defender.Easm.dll
Package:
Azure.Analytics.Defender.Easm v1.0.0-beta.1

Overloads

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

[Protocol Method] Retrieve a list of discovery group for the provided search parameters.
GetDiscoveryGroups(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Retrieve a list of discovery group for the provided search parameters.

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

Source:
EasmClient.cs

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

public virtual Azure.Pageable<BinaryData> GetDiscoveryGroups (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);
abstract member GetDiscoveryGroups : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDiscoveryGroups : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetDiscoveryGroups (filter 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.

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

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

Applies to

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

Source:
EasmClient.cs

Retrieve a list of discovery group for the provided search parameters.

public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroups (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDiscoveryGroups : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryGroup>
override this.GetDiscoveryGroups : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryGroup>
Public Overridable Function GetDiscoveryGroups (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 DiscoveryGroup)

Parameters

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

Examples

This sample shows how to call GetDiscoveryGroups.

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

foreach (DiscoveryGroup item in client.GetDiscoveryGroups())
{
}

This sample shows how to call GetDiscoveryGroups with all parameters.

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

foreach (DiscoveryGroup item in client.GetDiscoveryGroups(filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}

Applies to