EasmClient.GetSnapshot Method

Definition

Namespace:

Azure.Analytics.Defender.Easm

Assembly:

Azure.Analytics.Defender.Easm.dll

Package:

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

Overloads

GetSnapshot(ReportAssetSnapshotPayload, CancellationToken)	Get the most recent snapshot of asset summary values for the snapshot request.
GetSnapshot(RequestContent, RequestContext)	[Protocol Method] Get the most recent snapshot of asset summary values for the snapshot request. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetSnapshot(ReportAssetSnapshotPayload, CancellationToken) convenience overload with strongly typed models first.

GetSnapshot(ReportAssetSnapshotPayload, CancellationToken)

Source:

EasmClient.cs

Get the most recent snapshot of asset summary values for the snapshot request.

public virtual Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult> GetSnapshot(Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload reportAssetSnapshotPayload, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSnapshot : Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>
override this.GetSnapshot : Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>

Public Overridable Function GetSnapshot (reportAssetSnapshotPayload As ReportAssetSnapshotPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReportAssetSnapshotResult)

Parameters

reportAssetSnapshotPayload

ReportAssetSnapshotPayload

A request body used to retrieve an asset report snapshot.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<ReportAssetSnapshotResult>

Exceptions

ArgumentNullException

reportAssetSnapshotPayload is null.

Examples

This sample shows how to call GetSnapshot.

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

ReportAssetSnapshotPayload reportAssetSnapshotPayload = new ReportAssetSnapshotPayload();
Response<ReportAssetSnapshotResult> response = client.GetSnapshot(reportAssetSnapshotPayload);

This sample shows how to call GetSnapshot with all parameters.

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

ReportAssetSnapshotPayload reportAssetSnapshotPayload = new ReportAssetSnapshotPayload
{
    Metric = "<metric>",
    LabelName = "<labelName>",
    Size = 1234,
    Page = 1234,
};
Response<ReportAssetSnapshotResult> response = client.GetSnapshot(reportAssetSnapshotPayload);

GetSnapshot(RequestContent, RequestContext)

Source:

EasmClient.cs

[Protocol Method] Get the most recent snapshot of asset summary values for the snapshot request.

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

public virtual Azure.Response GetSnapshot(Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member GetSnapshot : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.GetSnapshot : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function GetSnapshot (content As RequestContent, Optional context As RequestContext = Nothing) As 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

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 GetSnapshot 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 object());
Response response = client.GetSnapshot(content);

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

This sample shows how to call GetSnapshot 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
{
    metric = "<metric>",
    labelName = "<labelName>",
    size = 1234,
    page = 1234,
});
Response response = client.GetSnapshot(content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("metric").ToString());
Console.WriteLine(result.GetProperty("labelName").ToString());
Console.WriteLine(result.GetProperty("updatedAt").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("totalElements").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("mark").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("nextLink").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("uuid").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("externalId").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("labels")[0].ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("wildcard").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("discoGroupName").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("auditTrail")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("auditTrail")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("auditTrail")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("auditTrail")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("auditTrail")[0].GetProperty("reason").ToString());
Console.WriteLine(result.GetProperty("assets").GetProperty("value")[0].GetProperty("reason").ToString());