xml/Azure.Analytics.Defender.Easm/EasmClient.xml (6,137 lines of code) (raw):
<Type Name="EasmClient" FullName="Azure.Analytics.Defender.Easm.EasmClient">
<TypeSignature Language="C#" Value="public class EasmClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EasmClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Analytics.Defender.Easm.EasmClient" />
<TypeSignature Language="VB.NET" Value="Public Class EasmClient" />
<TypeSignature Language="F#" Value="type EasmClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The Easm service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected EasmClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of EasmClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EasmClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Defender.Easm.EasmClient : Uri * Azure.Core.TokenCredential -> Azure.Analytics.Defender.Easm.EasmClient" Usage="new Azure.Analytics.Defender.Easm.EasmClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint"> The endpoint hosting the requested resource. For example, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of EasmClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EasmClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.Analytics.Defender.Easm.EasmClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.Analytics.Defender.Easm.EasmClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.Analytics.Defender.Easm.EasmClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As EasmClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Defender.Easm.EasmClient : Uri * Azure.Core.TokenCredential * Azure.Analytics.Defender.Easm.EasmClientOptions -> Azure.Analytics.Defender.Easm.EasmClient" Usage="new Azure.Analytics.Defender.Easm.EasmClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.Analytics.Defender.Easm.EasmClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> The endpoint hosting the requested resource. For example, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of EasmClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CancelTask">
<MemberSignature Language="C#" Value="public virtual Azure.Response CancelTask (string taskId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CancelTask(string taskId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CancelTask(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTask (taskId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member CancelTask : string * Azure.RequestContext -> Azure.Response
override this.CancelTask : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.CancelTask (taskId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Cancel a task by taskId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CancelTask(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CancelTask and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.CancelTask("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call CancelTask with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.CancelTask("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CancelTask">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.TaskResource> CancelTask (string taskId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.TaskResource> CancelTask(string taskId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CancelTask(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTask (taskId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TaskResource)" />
<MemberSignature Language="F#" Value="abstract member CancelTask : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>
override this.CancelTask : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>" Usage="easmClient.CancelTask (taskId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.TaskResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Cancel a task by taskId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CancelTask.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = client.CancelTask("<taskId>");
]]></code>
This sample shows how to call CancelTask with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = client.CancelTask("<taskId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="CancelTaskAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CancelTaskAsync (string taskId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CancelTaskAsync(string taskId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CancelTaskAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTaskAsync (taskId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member CancelTaskAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelTaskAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.CancelTaskAsync (taskId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Cancel a task by taskId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CancelTaskAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CancelTaskAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.CancelTaskAsync("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call CancelTaskAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.CancelTaskAsync("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CancelTaskAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>> CancelTaskAsync (string taskId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.TaskResource>> CancelTaskAsync(string taskId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CancelTaskAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTaskAsync (taskId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TaskResource))" />
<MemberSignature Language="F#" Value="abstract member CancelTaskAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>>
override this.CancelTaskAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>>" Usage="easmClient.CancelTaskAsync (taskId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Cancel a task by taskId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CancelTaskAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = await client.CancelTaskAsync("<taskId>");
]]></code>
This sample shows how to call CancelTaskAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = await client.CancelTaskAsync("<taskId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.DataConnection> CreateOrReplaceDataConnection (string dataConnectionName, Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.DataConnection> CreateOrReplaceDataConnection(string dataConnectionName, class Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDataConnection(System.String,Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDataConnection (dataConnectionName As String, dataConnectionPayload As DataConnectionPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DataConnection)" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDataConnection : string * Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>
override this.CreateOrReplaceDataConnection : string * Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>" Usage="easmClient.CreateOrReplaceDataConnection (dataConnectionName, dataConnectionPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.DataConnection></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="dataConnectionPayload" Type="Azure.Analytics.Defender.Easm.DataConnectionPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="dataConnectionPayload"> The <see cref="T:Azure.Analytics.Defender.Easm.DataConnectionPayload" /> to use. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Create or replace a data connection with a given dataConnectionName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> or <paramref name="dataConnectionPayload" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrReplaceDataConnection.
<code><![CDATA[
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<DataConnection> response = client.CreateOrReplaceDataConnection("<dataConnectionName>", dataConnectionPayload);
]]></code>
This sample shows how to call CreateOrReplaceDataConnection with all parameters.
<code><![CDATA[
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<DataConnection> response = client.CreateOrReplaceDataConnection("<dataConnectionName>", dataConnectionPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response CreateOrReplaceDataConnection (string dataConnectionName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateOrReplaceDataConnection(string dataConnectionName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDataConnection(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDataConnection (dataConnectionName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDataConnection : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateOrReplaceDataConnection : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.CreateOrReplaceDataConnection (dataConnectionName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Create or replace a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDataConnection(System.String,Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrReplaceDataConnection and parse the result.
<code><![CDATA[
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 = client.CreateOrReplaceDataConnection("<dataConnectionName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call CreateOrReplaceDataConnection with all parameters and request content and parse the result.
<code><![CDATA[
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 = client.CreateOrReplaceDataConnection("<dataConnectionName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDataConnectionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>> CreateOrReplaceDataConnectionAsync (string dataConnectionName, Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.DataConnection>> CreateOrReplaceDataConnectionAsync(string dataConnectionName, class Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDataConnectionAsync(System.String,Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDataConnectionAsync (dataConnectionName As String, dataConnectionPayload As DataConnectionPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataConnection))" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDataConnectionAsync : string * Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>>
override this.CreateOrReplaceDataConnectionAsync : string * Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>>" Usage="easmClient.CreateOrReplaceDataConnectionAsync (dataConnectionName, dataConnectionPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="dataConnectionPayload" Type="Azure.Analytics.Defender.Easm.DataConnectionPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="dataConnectionPayload"> The <see cref="T:Azure.Analytics.Defender.Easm.DataConnectionPayload" /> to use. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Create or replace a data connection with a given dataConnectionName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> or <paramref name="dataConnectionPayload" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrReplaceDataConnectionAsync.
<code><![CDATA[
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<DataConnection> response = await client.CreateOrReplaceDataConnectionAsync("<dataConnectionName>", dataConnectionPayload);
]]></code>
This sample shows how to call CreateOrReplaceDataConnectionAsync with all parameters.
<code><![CDATA[
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<DataConnection> response = await client.CreateOrReplaceDataConnectionAsync("<dataConnectionName>", dataConnectionPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDataConnectionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrReplaceDataConnectionAsync (string dataConnectionName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateOrReplaceDataConnectionAsync(string dataConnectionName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDataConnectionAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDataConnectionAsync (dataConnectionName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDataConnectionAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrReplaceDataConnectionAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.CreateOrReplaceDataConnectionAsync (dataConnectionName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Create or replace a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDataConnectionAsync(System.String,Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrReplaceDataConnectionAsync and parse the result.
<code><![CDATA[
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.CreateOrReplaceDataConnectionAsync("<dataConnectionName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call CreateOrReplaceDataConnectionAsync with all parameters and request content and parse the result.
<code><![CDATA[
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.CreateOrReplaceDataConnectionAsync("<dataConnectionName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup> CreateOrReplaceDiscoveryGroup (string groupName, Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.DiscoveryGroup> CreateOrReplaceDiscoveryGroup(string groupName, class Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDiscoveryGroup(System.String,Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDiscoveryGroup (groupName As String, discoveryGroupPayload As DiscoveryGroupPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DiscoveryGroup)" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDiscoveryGroup : string * Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>
override this.CreateOrReplaceDiscoveryGroup : string * Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>" Usage="easmClient.CreateOrReplaceDiscoveryGroup (groupName, discoveryGroupPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="discoveryGroupPayload" Type="Azure.Analytics.Defender.Easm.DiscoveryGroupPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="discoveryGroupPayload"> A request body used to create a discovery group. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Create a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> or <paramref name="discoveryGroupPayload" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrReplaceDiscoveryGroup.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload();
Response<DiscoveryGroup> response = client.CreateOrReplaceDiscoveryGroup("<groupName>", discoveryGroupPayload);
]]></code>
This sample shows how to call CreateOrReplaceDiscoveryGroup with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload
{
Name = "<name>",
Description = "<description>",
Tier = "<tier>",
FrequencyMilliseconds = 1234L,
Seeds = {new DiscoverySource
{
Kind = DiscoverySourceKind.As,
Name = "<name>",
}},
Names = { "<names>" },
Excludes = { default },
TemplateId = "<templateId>",
};
Response<DiscoveryGroup> response = client.CreateOrReplaceDiscoveryGroup("<groupName>", discoveryGroupPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response CreateOrReplaceDiscoveryGroup (string groupName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateOrReplaceDiscoveryGroup(string groupName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDiscoveryGroup(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDiscoveryGroup (groupName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDiscoveryGroup : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateOrReplaceDiscoveryGroup : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.CreateOrReplaceDiscoveryGroup (groupName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Create a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDiscoveryGroup(System.String,Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrReplaceDiscoveryGroup and parse the result.
<code><![CDATA[
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.CreateOrReplaceDiscoveryGroup("<groupName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call CreateOrReplaceDiscoveryGroup with all parameters and request content and parse the result.
<code><![CDATA[
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
{
name = "<name>",
description = "<description>",
tier = "<tier>",
frequencyMilliseconds = 1234L,
seeds = new object[]
{
new
{
kind = "as",
name = "<name>",
}
},
names = new object[]
{
"<names>"
},
excludes = new object[]
{
null
},
templateId = "<templateId>",
});
Response response = client.CreateOrReplaceDiscoveryGroup("<groupName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>> CreateOrReplaceDiscoveryGroupAsync (string groupName, Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.DiscoveryGroup>> CreateOrReplaceDiscoveryGroupAsync(string groupName, class Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDiscoveryGroupAsync(System.String,Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDiscoveryGroupAsync (groupName As String, discoveryGroupPayload As DiscoveryGroupPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DiscoveryGroup))" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDiscoveryGroupAsync : string * Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>>
override this.CreateOrReplaceDiscoveryGroupAsync : string * Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>>" Usage="easmClient.CreateOrReplaceDiscoveryGroupAsync (groupName, discoveryGroupPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="discoveryGroupPayload" Type="Azure.Analytics.Defender.Easm.DiscoveryGroupPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="discoveryGroupPayload"> A request body used to create a discovery group. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Create a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> or <paramref name="discoveryGroupPayload" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrReplaceDiscoveryGroupAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload();
Response<DiscoveryGroup> response = await client.CreateOrReplaceDiscoveryGroupAsync("<groupName>", discoveryGroupPayload);
]]></code>
This sample shows how to call CreateOrReplaceDiscoveryGroupAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload
{
Name = "<name>",
Description = "<description>",
Tier = "<tier>",
FrequencyMilliseconds = 1234L,
Seeds = {new DiscoverySource
{
Kind = DiscoverySourceKind.As,
Name = "<name>",
}},
Names = { "<names>" },
Excludes = { default },
TemplateId = "<templateId>",
};
Response<DiscoveryGroup> response = await client.CreateOrReplaceDiscoveryGroupAsync("<groupName>", discoveryGroupPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrReplaceDiscoveryGroupAsync (string groupName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateOrReplaceDiscoveryGroupAsync(string groupName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDiscoveryGroupAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceDiscoveryGroupAsync (groupName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceDiscoveryGroupAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrReplaceDiscoveryGroupAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.CreateOrReplaceDiscoveryGroupAsync (groupName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Create a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceDiscoveryGroupAsync(System.String,Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrReplaceDiscoveryGroupAsync and parse the result.
<code><![CDATA[
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 = await client.CreateOrReplaceDiscoveryGroupAsync("<groupName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call CreateOrReplaceDiscoveryGroupAsync with all parameters and request content and parse the result.
<code><![CDATA[
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
{
name = "<name>",
description = "<description>",
tier = "<tier>",
frequencyMilliseconds = 1234L,
seeds = new object[]
{
new
{
kind = "as",
name = "<name>",
}
},
names = new object[]
{
"<names>"
},
excludes = new object[]
{
null
},
templateId = "<templateId>",
});
Response response = await client.CreateOrReplaceDiscoveryGroupAsync("<groupName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceSavedFilter">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter> CreateOrReplaceSavedFilter (string filterName, Azure.Analytics.Defender.Easm.SavedFilterPayload savedFilterPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.SavedFilter> CreateOrReplaceSavedFilter(string filterName, class Azure.Analytics.Defender.Easm.SavedFilterPayload savedFilterPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceSavedFilter(System.String,Azure.Analytics.Defender.Easm.SavedFilterPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceSavedFilter (filterName As String, savedFilterPayload As SavedFilterPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SavedFilter)" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceSavedFilter : string * Azure.Analytics.Defender.Easm.SavedFilterPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>
override this.CreateOrReplaceSavedFilter : string * Azure.Analytics.Defender.Easm.SavedFilterPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>" Usage="easmClient.CreateOrReplaceSavedFilter (filterName, savedFilterPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="savedFilterPayload" Type="Azure.Analytics.Defender.Easm.SavedFilterPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="savedFilterPayload"> A request body used to create a saved filter. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Create or replace a saved filter with a given filterName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> or <paramref name="savedFilterPayload" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrReplaceSavedFilter.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
SavedFilterPayload savedFilterPayload = new SavedFilterPayload("<filter>", "<description>");
Response<SavedFilter> response = client.CreateOrReplaceSavedFilter("<filterName>", savedFilterPayload);
]]></code>
This sample shows how to call CreateOrReplaceSavedFilter with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
SavedFilterPayload savedFilterPayload = new SavedFilterPayload("<filter>", "<description>");
Response<SavedFilter> response = client.CreateOrReplaceSavedFilter("<filterName>", savedFilterPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceSavedFilter">
<MemberSignature Language="C#" Value="public virtual Azure.Response CreateOrReplaceSavedFilter (string filterName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateOrReplaceSavedFilter(string filterName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceSavedFilter(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceSavedFilter (filterName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceSavedFilter : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateOrReplaceSavedFilter : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.CreateOrReplaceSavedFilter (filterName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Create or replace a saved filter with a given filterName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceSavedFilter(System.String,Azure.Analytics.Defender.Easm.SavedFilterPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrReplaceSavedFilter and parse the result.
<code><![CDATA[
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
{
filter = "<filter>",
description = "<description>",
});
Response response = client.CreateOrReplaceSavedFilter("<filterName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call CreateOrReplaceSavedFilter with all parameters and request content and parse the result.
<code><![CDATA[
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
{
filter = "<filter>",
description = "<description>",
});
Response response = client.CreateOrReplaceSavedFilter("<filterName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("filter").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceSavedFilterAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>> CreateOrReplaceSavedFilterAsync (string filterName, Azure.Analytics.Defender.Easm.SavedFilterPayload savedFilterPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.SavedFilter>> CreateOrReplaceSavedFilterAsync(string filterName, class Azure.Analytics.Defender.Easm.SavedFilterPayload savedFilterPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceSavedFilterAsync(System.String,Azure.Analytics.Defender.Easm.SavedFilterPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceSavedFilterAsync (filterName As String, savedFilterPayload As SavedFilterPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SavedFilter))" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceSavedFilterAsync : string * Azure.Analytics.Defender.Easm.SavedFilterPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>>
override this.CreateOrReplaceSavedFilterAsync : string * Azure.Analytics.Defender.Easm.SavedFilterPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>>" Usage="easmClient.CreateOrReplaceSavedFilterAsync (filterName, savedFilterPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="savedFilterPayload" Type="Azure.Analytics.Defender.Easm.SavedFilterPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="savedFilterPayload"> A request body used to create a saved filter. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Create or replace a saved filter with a given filterName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> or <paramref name="savedFilterPayload" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrReplaceSavedFilterAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
SavedFilterPayload savedFilterPayload = new SavedFilterPayload("<filter>", "<description>");
Response<SavedFilter> response = await client.CreateOrReplaceSavedFilterAsync("<filterName>", savedFilterPayload);
]]></code>
This sample shows how to call CreateOrReplaceSavedFilterAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
SavedFilterPayload savedFilterPayload = new SavedFilterPayload("<filter>", "<description>");
Response<SavedFilter> response = await client.CreateOrReplaceSavedFilterAsync("<filterName>", savedFilterPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrReplaceSavedFilterAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrReplaceSavedFilterAsync (string filterName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateOrReplaceSavedFilterAsync(string filterName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceSavedFilterAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrReplaceSavedFilterAsync (filterName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member CreateOrReplaceSavedFilterAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrReplaceSavedFilterAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.CreateOrReplaceSavedFilterAsync (filterName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Create or replace a saved filter with a given filterName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.CreateOrReplaceSavedFilterAsync(System.String,Azure.Analytics.Defender.Easm.SavedFilterPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrReplaceSavedFilterAsync and parse the result.
<code><![CDATA[
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
{
filter = "<filter>",
description = "<description>",
});
Response response = await client.CreateOrReplaceSavedFilterAsync("<filterName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call CreateOrReplaceSavedFilterAsync with all parameters and request content and parse the result.
<code><![CDATA[
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
{
filter = "<filter>",
description = "<description>",
});
Response response = await client.CreateOrReplaceSavedFilterAsync("<filterName>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("filter").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response DeleteDataConnection (string dataConnectionName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteDataConnection(string dataConnectionName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.DeleteDataConnection(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDataConnection (dataConnectionName As String, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DeleteDataConnection : string * Azure.RequestContext -> Azure.Response
override this.DeleteDataConnection : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.DeleteDataConnection (dataConnectionName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Delete a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteDataConnection.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.DeleteDataConnection("<dataConnectionName>");
Console.WriteLine(response.Status);
]]></code>
This sample shows how to call DeleteDataConnection with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.DeleteDataConnection("<dataConnectionName>");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteDataConnectionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataConnectionAsync (string dataConnectionName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteDataConnectionAsync(string dataConnectionName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.DeleteDataConnectionAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDataConnectionAsync (dataConnectionName As String, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DeleteDataConnectionAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataConnectionAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.DeleteDataConnectionAsync (dataConnectionName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Delete a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteDataConnectionAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.DeleteDataConnectionAsync("<dataConnectionName>");
Console.WriteLine(response.Status);
]]></code>
This sample shows how to call DeleteDataConnectionAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.DeleteDataConnectionAsync("<dataConnectionName>");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteSavedFilter">
<MemberSignature Language="C#" Value="public virtual Azure.Response DeleteSavedFilter (string filterName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteSavedFilter(string filterName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.DeleteSavedFilter(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteSavedFilter (filterName As String, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DeleteSavedFilter : string * Azure.RequestContext -> Azure.Response
override this.DeleteSavedFilter : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.DeleteSavedFilter (filterName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Delete a saved filter with a given filterName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteSavedFilter.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.DeleteSavedFilter("<filterName>");
Console.WriteLine(response.Status);
]]></code>
This sample shows how to call DeleteSavedFilter with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.DeleteSavedFilter("<filterName>");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteSavedFilterAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteSavedFilterAsync (string filterName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteSavedFilterAsync(string filterName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.DeleteSavedFilterAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteSavedFilterAsync (filterName As String, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DeleteSavedFilterAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteSavedFilterAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.DeleteSavedFilterAsync (filterName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Delete a saved filter with a given filterName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteSavedFilterAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.DeleteSavedFilterAsync("<filterName>");
Console.WriteLine(response.Status);
]]></code>
This sample shows how to call DeleteSavedFilterAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.DeleteSavedFilterAsync("<filterName>");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResource">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetAssetResource (string assetId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetAssetResource(string assetId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResource(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResource (assetId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetAssetResource : string * Azure.RequestContext -> Azure.Response
override this.GetAssetResource : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetAssetResource (assetId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assetId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="assetId"> The system generated unique id for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve an asset by assetId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResource(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="assetId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="assetId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAssetResource and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetAssetResource("<assetId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call GetAssetResource with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetAssetResource("<assetId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("uuid").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("externalId").ToString());
Console.WriteLine(result.GetProperty("labels")[0].ToString());
Console.WriteLine(result.GetProperty("wildcard").ToString());
Console.WriteLine(result.GetProperty("discoGroupName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("reason").ToString());
Console.WriteLine(result.GetProperty("reason").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResource">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.AssetResource> GetAssetResource (string assetId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.AssetResource> GetAssetResource(string assetId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResource(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResource (assetId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AssetResource)" />
<MemberSignature Language="F#" Value="abstract member GetAssetResource : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.AssetResource>
override this.GetAssetResource : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.AssetResource>" Usage="easmClient.GetAssetResource (assetId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.AssetResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assetId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="assetId"> The system generated unique id for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve an asset by assetId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="assetId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="assetId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetAssetResource.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<AssetResource> response = client.GetAssetResource("<assetId>");
]]></code>
This sample shows how to call GetAssetResource with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<AssetResource> response = client.GetAssetResource("<assetId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResourceAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetAssetResourceAsync (string assetId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetAssetResourceAsync(string assetId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResourceAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResourceAsync (assetId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetAssetResourceAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAssetResourceAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetAssetResourceAsync (assetId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assetId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="assetId"> The system generated unique id for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve an asset by assetId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResourceAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="assetId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="assetId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAssetResourceAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetAssetResourceAsync("<assetId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call GetAssetResourceAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetAssetResourceAsync("<assetId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("uuid").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("externalId").ToString());
Console.WriteLine(result.GetProperty("labels")[0].ToString());
Console.WriteLine(result.GetProperty("wildcard").ToString());
Console.WriteLine(result.GetProperty("discoGroupName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("reason").ToString());
Console.WriteLine(result.GetProperty("reason").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResourceAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.AssetResource>> GetAssetResourceAsync (string assetId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.AssetResource>> GetAssetResourceAsync(string assetId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResourceAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResourceAsync (assetId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AssetResource))" />
<MemberSignature Language="F#" Value="abstract member GetAssetResourceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.AssetResource>>
override this.GetAssetResourceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.AssetResource>>" Usage="easmClient.GetAssetResourceAsync (assetId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.AssetResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assetId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="assetId"> The system generated unique id for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve an asset by assetId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="assetId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="assetId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetAssetResourceAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<AssetResource> response = await client.GetAssetResourceAsync("<assetId>");
]]></code>
This sample shows how to call GetAssetResourceAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<AssetResource> response = await client.GetAssetResourceAsync("<assetId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResources">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetAssetResources (string filter, string orderby, int? skip, int? maxpagesize, string mark, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetAssetResources(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, string mark, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResources(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResources (filter As String, orderby As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), mark As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAssetResources : string * string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAssetResources : string * string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="easmClient.GetAssetResources (filter, orderby, skip, maxpagesize, mark, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="mark" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="mark"> Specify this value instead of 'skip' to use cursor-based searching. Initial value is '*' and subsequent values are returned in the response. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of assets for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResources(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAssetResources and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetAssetResources(null, null, null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
}
]]></code>
This sample shows how to call GetAssetResources with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetAssetResources("<filter>", "<orderby>", 1234, 1234, "<mark>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("uuid").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("externalId").ToString());
Console.WriteLine(result.GetProperty("labels")[0].ToString());
Console.WriteLine(result.GetProperty("wildcard").ToString());
Console.WriteLine(result.GetProperty("discoGroupName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("reason").ToString());
Console.WriteLine(result.GetProperty("reason").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResources">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.AssetResource> GetAssetResources (string filter = default, string orderby = default, int? skip = default, int? maxpagesize = default, string mark = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.AssetResource> GetAssetResources(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, string mark, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResources(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResources (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 mark As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of AssetResource)" />
<MemberSignature Language="F#" Value="abstract member GetAssetResources : string * string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.AssetResource>
override this.GetAssetResources : string * string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.AssetResource>" Usage="easmClient.GetAssetResources (filter, orderby, skip, maxpagesize, mark, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.AssetResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="mark" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="mark"> Specify this value instead of 'skip' to use cursor-based searching. Initial value is '*' and subsequent values are returned in the response. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of assets for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetAssetResources.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (AssetResource item in client.GetAssetResources())
{
}
]]></code>
This sample shows how to call GetAssetResources with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (AssetResource item in client.GetAssetResources(filter: "<filter>", orderby: "<orderby>", skip: 1234, maxpagesize: 1234, mark: "<mark>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResourcesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetAssetResourcesAsync (string filter, string orderby, int? skip, int? maxpagesize, string mark, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetAssetResourcesAsync(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, string mark, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResourcesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResourcesAsync (filter As String, orderby As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), mark As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAssetResourcesAsync : string * string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAssetResourcesAsync : string * string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetAssetResourcesAsync (filter, orderby, skip, maxpagesize, mark, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="mark" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="mark"> Specify this value instead of 'skip' to use cursor-based searching. Initial value is '*' and subsequent values are returned in the response. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of assets for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResourcesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAssetResourcesAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetAssetResourcesAsync(null, null, null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
}
]]></code>
This sample shows how to call GetAssetResourcesAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetAssetResourcesAsync("<filter>", "<orderby>", 1234, 1234, "<mark>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("uuid").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("externalId").ToString());
Console.WriteLine(result.GetProperty("labels")[0].ToString());
Console.WriteLine(result.GetProperty("wildcard").ToString());
Console.WriteLine(result.GetProperty("discoGroupName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("auditTrail")[0].GetProperty("reason").ToString());
Console.WriteLine(result.GetProperty("reason").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAssetResourcesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.AssetResource> GetAssetResourcesAsync (string filter = default, string orderby = default, int? skip = default, int? maxpagesize = default, string mark = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.AssetResource> GetAssetResourcesAsync(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, string mark, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetAssetResourcesAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAssetResourcesAsync (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 mark As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of AssetResource)" />
<MemberSignature Language="F#" Value="abstract member GetAssetResourcesAsync : string * string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.AssetResource>
override this.GetAssetResourcesAsync : string * string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.AssetResource>" Usage="easmClient.GetAssetResourcesAsync (filter, orderby, skip, maxpagesize, mark, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.AssetResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="mark" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="mark"> Specify this value instead of 'skip' to use cursor-based searching. Initial value is '*' and subsequent values are returned in the response. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of assets for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetAssetResourcesAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (AssetResource item in client.GetAssetResourcesAsync())
{
}
]]></code>
This sample shows how to call GetAssetResourcesAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (AssetResource item in client.GetAssetResourcesAsync(filter: "<filter>", orderby: "<orderby>", skip: 1234, maxpagesize: 1234, mark: "<mark>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetBillable">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetBillable (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetBillable(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetBillable(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetBillable (context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetBillable : Azure.RequestContext -> Azure.Response
override this.GetBillable : Azure.RequestContext -> Azure.Response" Usage="easmClient.GetBillable context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get billable assets summary for the workspace.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetBillable(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetBillable and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetBillable(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetBillable with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetBillable(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("date").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("total").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("assetBreakdown")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("assetBreakdown")[0].GetProperty("count").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetBillable">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult> GetBillable (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult> GetBillable(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetBillable(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetBillable (Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReportBillableAssetSummaryResult)" />
<MemberSignature Language="F#" Value="abstract member GetBillable : System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>
override this.GetBillable : System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>" Usage="easmClient.GetBillable cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get billable assets summary for the workspace. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetBillable.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<ReportBillableAssetSummaryResult> response = client.GetBillable();
]]></code>
This sample shows how to call GetBillable with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<ReportBillableAssetSummaryResult> response = client.GetBillable();
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetBillableAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetBillableAsync (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetBillableAsync(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetBillableAsync(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetBillableAsync (context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetBillableAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetBillableAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetBillableAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get billable assets summary for the workspace.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetBillableAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetBillableAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetBillableAsync(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetBillableAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetBillableAsync(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("date").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("total").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("assetBreakdown")[0].GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("assetBreakdown")[0].GetProperty("count").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetBillableAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>> GetBillableAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>> GetBillableAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetBillableAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetBillableAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ReportBillableAssetSummaryResult))" />
<MemberSignature Language="F#" Value="abstract member GetBillableAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>>
override this.GetBillableAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>>" Usage="easmClient.GetBillableAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportBillableAssetSummaryResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get billable assets summary for the workspace. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetBillableAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<ReportBillableAssetSummaryResult> response = await client.GetBillableAsync();
]]></code>
This sample shows how to call GetBillableAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<ReportBillableAssetSummaryResult> response = await client.GetBillableAsync();
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetDataConnection (string dataConnectionName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDataConnection(string dataConnectionName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnection(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnection (dataConnectionName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetDataConnection : string * Azure.RequestContext -> Azure.Response
override this.GetDataConnection : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetDataConnection (dataConnectionName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnection(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDataConnection and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetDataConnection("<dataConnectionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetDataConnection with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetDataConnection("<dataConnectionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.DataConnection> GetDataConnection (string dataConnectionName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.DataConnection> GetDataConnection(string dataConnectionName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnection(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnection (dataConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DataConnection)" />
<MemberSignature Language="F#" Value="abstract member GetDataConnection : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>
override this.GetDataConnection : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>" Usage="easmClient.GetDataConnection (dataConnectionName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.DataConnection></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a data connection with a given dataConnectionName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDataConnection.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DataConnection> response = client.GetDataConnection("<dataConnectionName>");
]]></code>
This sample shows how to call GetDataConnection with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DataConnection> response = client.GetDataConnection("<dataConnectionName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnectionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDataConnectionAsync (string dataConnectionName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDataConnectionAsync(string dataConnectionName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnectionAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnectionAsync (dataConnectionName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetDataConnectionAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDataConnectionAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetDataConnectionAsync (dataConnectionName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnectionAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDataConnectionAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetDataConnectionAsync("<dataConnectionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetDataConnectionAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetDataConnectionAsync("<dataConnectionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnectionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>> GetDataConnectionAsync (string dataConnectionName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.DataConnection>> GetDataConnectionAsync(string dataConnectionName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnectionAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnectionAsync (dataConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataConnection))" />
<MemberSignature Language="F#" Value="abstract member GetDataConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>>
override this.GetDataConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>>" Usage="easmClient.GetDataConnectionAsync (dataConnectionName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DataConnection>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="dataConnectionName"> The caller provided unique name for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a data connection with a given dataConnectionName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="dataConnectionName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDataConnectionAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DataConnection> response = await client.GetDataConnectionAsync("<dataConnectionName>");
]]></code>
This sample shows how to call GetDataConnectionAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DataConnection> response = await client.GetDataConnectionAsync("<dataConnectionName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnections">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetDataConnections (int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetDataConnections(valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnections(System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnections (skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDataConnections : Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDataConnections : Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="easmClient.GetDataConnections (skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of data connections.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnections(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDataConnections and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetDataConnections(null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetDataConnections with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetDataConnections(1234, 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnections">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.DataConnection> GetDataConnections (int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.DataConnection> GetDataConnections(valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnections(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnections (Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DataConnection)" />
<MemberSignature Language="F#" Value="abstract member GetDataConnections : Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.DataConnection>
override this.GetDataConnections : Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.DataConnection>" Usage="easmClient.GetDataConnections (skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.DataConnection></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of data connections. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetDataConnections.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (DataConnection item in client.GetDataConnections())
{
}
]]></code>
This sample shows how to call GetDataConnections with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (DataConnection item in client.GetDataConnections(skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnectionsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetDataConnectionsAsync (int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetDataConnectionsAsync(valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnectionsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnectionsAsync (skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDataConnectionsAsync : Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDataConnectionsAsync : Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetDataConnectionsAsync (skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of data connections.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnectionsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDataConnectionsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDataConnectionsAsync(null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetDataConnectionsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDataConnectionsAsync(1234, 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("content").ToString());
Console.WriteLine(result.GetProperty("createdDate").ToString());
Console.WriteLine(result.GetProperty("frequency").ToString());
Console.WriteLine(result.GetProperty("frequencyOffset").ToString());
Console.WriteLine(result.GetProperty("updatedDate").ToString());
Console.WriteLine(result.GetProperty("userUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("active").ToString());
Console.WriteLine(result.GetProperty("inactiveMessage").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDataConnectionsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DataConnection> GetDataConnectionsAsync (int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.DataConnection> GetDataConnectionsAsync(valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDataConnectionsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataConnectionsAsync (Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DataConnection)" />
<MemberSignature Language="F#" Value="abstract member GetDataConnectionsAsync : Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DataConnection>
override this.GetDataConnectionsAsync : Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DataConnection>" Usage="easmClient.GetDataConnectionsAsync (skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DataConnection></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of data connections. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetDataConnectionsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DataConnection item in client.GetDataConnectionsAsync())
{
}
]]></code>
This sample shows how to call GetDataConnectionsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DataConnection item in client.GetDataConnectionsAsync(skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetDiscoveryGroup (string groupName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDiscoveryGroup(string groupName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroup(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroup (groupName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroup : string * Azure.RequestContext -> Azure.Response
override this.GetDiscoveryGroup : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetDiscoveryGroup (groupName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroup(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryGroup and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetDiscoveryGroup("<groupName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetDiscoveryGroup with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetDiscoveryGroup("<groupName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroup (string groupName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroup(string groupName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroup(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroup (groupName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DiscoveryGroup)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroup : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>
override this.GetDiscoveryGroup : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>" Usage="easmClient.GetDiscoveryGroup (groupName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDiscoveryGroup.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryGroup> response = client.GetDiscoveryGroup("<groupName>");
]]></code>
This sample shows how to call GetDiscoveryGroup with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryGroup> response = client.GetDiscoveryGroup("<groupName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDiscoveryGroupAsync (string groupName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDiscoveryGroupAsync(string groupName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroupAsync (groupName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDiscoveryGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetDiscoveryGroupAsync (groupName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryGroupAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetDiscoveryGroupAsync("<groupName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetDiscoveryGroupAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetDiscoveryGroupAsync("<groupName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>> GetDiscoveryGroupAsync (string groupName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.DiscoveryGroup>> GetDiscoveryGroupAsync(string groupName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroupAsync (groupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DiscoveryGroup))" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>>
override this.GetDiscoveryGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>>" Usage="easmClient.GetDiscoveryGroupAsync (groupName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryGroup>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDiscoveryGroupAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryGroup> response = await client.GetDiscoveryGroupAsync("<groupName>");
]]></code>
This sample shows how to call GetDiscoveryGroupAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryGroup> response = await client.GetDiscoveryGroupAsync("<groupName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupRuns">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetDiscoveryGroupRuns (string groupName, string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetDiscoveryGroupRuns(string groupName, string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupRuns(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="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)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetDiscoveryGroupRuns (groupName, filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The unique identifier for the discovery group. </param>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a collection of discovery run results for a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupRuns(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryGroupRuns and parse the result.
<code><![CDATA[
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());
}
]]></code>
This sample shows how to call GetDiscoveryGroupRuns with all parameters and parse the result.
<code><![CDATA[
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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupRuns">
<MemberSignature Language="C#" Value="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);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.DiscoveryRunResult> GetDiscoveryGroupRuns(string groupName, string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupRuns(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="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)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetDiscoveryGroupRuns (groupName, filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryRunResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="groupName"> The unique identifier for the discovery group. </param>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a collection of discovery run results for a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDiscoveryGroupRuns.
<code><![CDATA[
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>"))
{
}
]]></code>
This sample shows how to call GetDiscoveryGroupRuns with all parameters.
<code><![CDATA[
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))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupRunsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetDiscoveryGroupRunsAsync (string groupName, string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetDiscoveryGroupRunsAsync(string groupName, string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupRunsAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroupRunsAsync (groupName As String, filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroupRunsAsync : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDiscoveryGroupRunsAsync : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetDiscoveryGroupRunsAsync (groupName, filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The unique identifier for the discovery group. </param>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a collection of discovery run results for a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupRunsAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryGroupRunsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDiscoveryGroupRunsAsync("<groupName>", null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.ToString());
}
]]></code>
This sample shows how to call GetDiscoveryGroupRunsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDiscoveryGroupRunsAsync("<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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupRunsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryRunResult> GetDiscoveryGroupRunsAsync (string groupName, string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.DiscoveryRunResult> GetDiscoveryGroupRunsAsync(string groupName, string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupRunsAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroupRunsAsync (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 AsyncPageable(Of DiscoveryRunResult)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroupRunsAsync : string * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryRunResult>
override this.GetDiscoveryGroupRunsAsync : string * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryRunResult>" Usage="easmClient.GetDiscoveryGroupRunsAsync (groupName, filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryRunResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="groupName"> The unique identifier for the discovery group. </param>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a collection of discovery run results for a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDiscoveryGroupRunsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DiscoveryRunResult item in client.GetDiscoveryGroupRunsAsync("<groupName>"))
{
}
]]></code>
This sample shows how to call GetDiscoveryGroupRunsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DiscoveryRunResult item in client.GetDiscoveryGroupRunsAsync("<groupName>", filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroups">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetDiscoveryGroups (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetDiscoveryGroups(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroups(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroups (filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetDiscoveryGroups (filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of discovery group for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroups(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryGroups and parse the result.
<code><![CDATA[
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());
}
]]></code>
This sample shows how to call GetDiscoveryGroups with all parameters and parse the result.
<code><![CDATA[
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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroups">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroups (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroups(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroups(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="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)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetDiscoveryGroups (filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryGroup></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of discovery group for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetDiscoveryGroups.
<code><![CDATA[
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())
{
}
]]></code>
This sample shows how to call GetDiscoveryGroups with all parameters.
<code><![CDATA[
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))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetDiscoveryGroupsAsync (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetDiscoveryGroupsAsync(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroupsAsync (filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroupsAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDiscoveryGroupsAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetDiscoveryGroupsAsync (filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of discovery group for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryGroupsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDiscoveryGroupsAsync(null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetDiscoveryGroupsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDiscoveryGroupsAsync("<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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryGroupsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroupsAsync (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.DiscoveryGroup> GetDiscoveryGroupsAsync(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryGroupsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryGroupsAsync (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 AsyncPageable(Of DiscoveryGroup)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryGroupsAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryGroup>
override this.GetDiscoveryGroupsAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryGroup>" Usage="easmClient.GetDiscoveryGroupsAsync (filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryGroup></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of discovery group for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetDiscoveryGroupsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DiscoveryGroup item in client.GetDiscoveryGroupsAsync())
{
}
]]></code>
This sample shows how to call GetDiscoveryGroupsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DiscoveryGroup item in client.GetDiscoveryGroupsAsync(filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplate">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetDiscoveryTemplate (string templateId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDiscoveryTemplate(string templateId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplate(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplate (templateId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplate : string * Azure.RequestContext -> Azure.Response
override this.GetDiscoveryTemplate : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetDiscoveryTemplate (templateId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="templateId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="templateId"> The system generated unique id for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a disco template with a given templateId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplate(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="templateId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="templateId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryTemplate and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetDiscoveryTemplate("<templateId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call GetDiscoveryTemplate with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetDiscoveryTemplate("<templateId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("industry").ToString());
Console.WriteLine(result.GetProperty("region").ToString());
Console.WriteLine(result.GetProperty("countryCode").ToString());
Console.WriteLine(result.GetProperty("stateCode").ToString());
Console.WriteLine(result.GetProperty("city").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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplate">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate> GetDiscoveryTemplate (string templateId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.DiscoveryTemplate> GetDiscoveryTemplate(string templateId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplate(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplate (templateId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DiscoveryTemplate)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplate : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate>
override this.GetDiscoveryTemplate : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate>" Usage="easmClient.GetDiscoveryTemplate (templateId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="templateId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="templateId"> The system generated unique id for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a disco template with a given templateId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="templateId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="templateId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDiscoveryTemplate.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryTemplate> response = client.GetDiscoveryTemplate("<templateId>");
]]></code>
This sample shows how to call GetDiscoveryTemplate with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryTemplate> response = client.GetDiscoveryTemplate("<templateId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDiscoveryTemplateAsync (string templateId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDiscoveryTemplateAsync(string templateId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplateAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplateAsync (templateId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplateAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDiscoveryTemplateAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetDiscoveryTemplateAsync (templateId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="templateId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="templateId"> The system generated unique id for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a disco template with a given templateId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplateAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="templateId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="templateId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryTemplateAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetDiscoveryTemplateAsync("<templateId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call GetDiscoveryTemplateAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetDiscoveryTemplateAsync("<templateId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("industry").ToString());
Console.WriteLine(result.GetProperty("region").ToString());
Console.WriteLine(result.GetProperty("countryCode").ToString());
Console.WriteLine(result.GetProperty("stateCode").ToString());
Console.WriteLine(result.GetProperty("city").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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate>> GetDiscoveryTemplateAsync (string templateId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.DiscoveryTemplate>> GetDiscoveryTemplateAsync(string templateId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplateAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplateAsync (templateId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DiscoveryTemplate))" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate>>
override this.GetDiscoveryTemplateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate>>" Usage="easmClient.GetDiscoveryTemplateAsync (templateId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.DiscoveryTemplate>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="templateId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="templateId"> The system generated unique id for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a disco template with a given templateId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="templateId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="templateId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetDiscoveryTemplateAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryTemplate> response = await client.GetDiscoveryTemplateAsync("<templateId>");
]]></code>
This sample shows how to call GetDiscoveryTemplateAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<DiscoveryTemplate> response = await client.GetDiscoveryTemplateAsync("<templateId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplates">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetDiscoveryTemplates (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetDiscoveryTemplates(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplates(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplates (filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplates : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDiscoveryTemplates : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="easmClient.GetDiscoveryTemplates (filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of disco templates for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplates(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryTemplates and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetDiscoveryTemplates(null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
}
]]></code>
This sample shows how to call GetDiscoveryTemplates with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetDiscoveryTemplates("<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("industry").ToString());
Console.WriteLine(result.GetProperty("region").ToString());
Console.WriteLine(result.GetProperty("countryCode").ToString());
Console.WriteLine(result.GetProperty("stateCode").ToString());
Console.WriteLine(result.GetProperty("city").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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplates">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate> GetDiscoveryTemplates (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.DiscoveryTemplate> GetDiscoveryTemplates(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplates(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplates (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 DiscoveryTemplate)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplates : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate>
override this.GetDiscoveryTemplates : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate>" Usage="easmClient.GetDiscoveryTemplates (filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of disco templates for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetDiscoveryTemplates.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (DiscoveryTemplate item in client.GetDiscoveryTemplates())
{
}
]]></code>
This sample shows how to call GetDiscoveryTemplates with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (DiscoveryTemplate item in client.GetDiscoveryTemplates(filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplatesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetDiscoveryTemplatesAsync (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetDiscoveryTemplatesAsync(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplatesAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplatesAsync (filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplatesAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDiscoveryTemplatesAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetDiscoveryTemplatesAsync (filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of disco templates for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplatesAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetDiscoveryTemplatesAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDiscoveryTemplatesAsync(null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
}
]]></code>
This sample shows how to call GetDiscoveryTemplatesAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetDiscoveryTemplatesAsync("<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("industry").ToString());
Console.WriteLine(result.GetProperty("region").ToString());
Console.WriteLine(result.GetProperty("countryCode").ToString());
Console.WriteLine(result.GetProperty("stateCode").ToString());
Console.WriteLine(result.GetProperty("city").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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetDiscoveryTemplatesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate> GetDiscoveryTemplatesAsync (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.DiscoveryTemplate> GetDiscoveryTemplatesAsync(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetDiscoveryTemplatesAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDiscoveryTemplatesAsync (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 AsyncPageable(Of DiscoveryTemplate)" />
<MemberSignature Language="F#" Value="abstract member GetDiscoveryTemplatesAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate>
override this.GetDiscoveryTemplatesAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate>" Usage="easmClient.GetDiscoveryTemplatesAsync (filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.DiscoveryTemplate></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of disco templates for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetDiscoveryTemplatesAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DiscoveryTemplate item in client.GetDiscoveryTemplatesAsync())
{
}
]]></code>
This sample shows how to call GetDiscoveryTemplatesAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (DiscoveryTemplate item in client.GetDiscoveryTemplatesAsync(filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFilter">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetSavedFilter (string filterName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetSavedFilter(string filterName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilter(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFilter (filterName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetSavedFilter : string * Azure.RequestContext -> Azure.Response
override this.GetSavedFilter : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetSavedFilter (filterName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a saved filter by filterName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilter(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSavedFilter and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetSavedFilter("<filterName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetSavedFilter with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetSavedFilter("<filterName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("filter").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFilter">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter> GetSavedFilter (string filterName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.SavedFilter> GetSavedFilter(string filterName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilter(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFilter (filterName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SavedFilter)" />
<MemberSignature Language="F#" Value="abstract member GetSavedFilter : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>
override this.GetSavedFilter : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>" Usage="easmClient.GetSavedFilter (filterName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a saved filter by filterName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetSavedFilter.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<SavedFilter> response = client.GetSavedFilter("<filterName>");
]]></code>
This sample shows how to call GetSavedFilter with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<SavedFilter> response = client.GetSavedFilter("<filterName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFilterAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetSavedFilterAsync (string filterName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetSavedFilterAsync(string filterName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilterAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFilterAsync (filterName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetSavedFilterAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSavedFilterAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetSavedFilterAsync (filterName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a saved filter by filterName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilterAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSavedFilterAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetSavedFilterAsync("<filterName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetSavedFilterAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetSavedFilterAsync("<filterName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("filter").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFilterAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>> GetSavedFilterAsync (string filterName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.SavedFilter>> GetSavedFilterAsync(string filterName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilterAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFilterAsync (filterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SavedFilter))" />
<MemberSignature Language="F#" Value="abstract member GetSavedFilterAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>>
override this.GetSavedFilterAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>>" Usage="easmClient.GetSavedFilterAsync (filterName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filterName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filterName"> The caller provided unique name for the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a saved filter by filterName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="filterName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetSavedFilterAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<SavedFilter> response = await client.GetSavedFilterAsync("<filterName>");
]]></code>
This sample shows how to call GetSavedFilterAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<SavedFilter> response = await client.GetSavedFilterAsync("<filterName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFilters">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetSavedFilters (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetSavedFilters(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilters(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFilters (filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetSavedFilters : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetSavedFilters : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="easmClient.GetSavedFilters (filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of saved filters for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilters(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSavedFilters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetSavedFilters(null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetSavedFilters with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (BinaryData item in client.GetSavedFilters("<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("filter").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFilters">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Analytics.Defender.Easm.SavedFilter> GetSavedFilters (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.SavedFilter> GetSavedFilters(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFilters(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFilters (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 SavedFilter)" />
<MemberSignature Language="F#" Value="abstract member GetSavedFilters : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.SavedFilter>
override this.GetSavedFilters : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Analytics.Defender.Easm.SavedFilter>" Usage="easmClient.GetSavedFilters (filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.SavedFilter></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of saved filters for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetSavedFilters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (SavedFilter item in client.GetSavedFilters())
{
}
]]></code>
This sample shows how to call GetSavedFilters with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
foreach (SavedFilter item in client.GetSavedFilters(filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFiltersAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetSavedFiltersAsync (string filter, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetSavedFiltersAsync(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFiltersAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFiltersAsync (filter As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetSavedFiltersAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetSavedFiltersAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetSavedFiltersAsync (filter, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of saved filters for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFiltersAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSavedFiltersAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetSavedFiltersAsync(null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetSavedFiltersAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetSavedFiltersAsync("<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("filter").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSavedFiltersAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.SavedFilter> GetSavedFiltersAsync (string filter = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.SavedFilter> GetSavedFiltersAsync(string filter, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSavedFiltersAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSavedFiltersAsync (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 AsyncPageable(Of SavedFilter)" />
<MemberSignature Language="F#" Value="abstract member GetSavedFiltersAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.SavedFilter>
override this.GetSavedFiltersAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.SavedFilter>" Usage="easmClient.GetSavedFiltersAsync (filter, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.SavedFilter></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of saved filters for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetSavedFiltersAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (SavedFilter item in client.GetSavedFiltersAsync())
{
}
]]></code>
This sample shows how to call GetSavedFiltersAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (SavedFilter item in client.GetSavedFiltersAsync(filter: "<filter>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSnapshot">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult> GetSnapshot (Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload reportAssetSnapshotPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult> GetSnapshot(class Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload reportAssetSnapshotPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSnapshot(Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSnapshot (reportAssetSnapshotPayload As ReportAssetSnapshotPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReportAssetSnapshotResult)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetSnapshot (reportAssetSnapshotPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reportAssetSnapshotPayload" Type="Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="reportAssetSnapshotPayload"> A request body used to retrieve an asset report snapshot. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get the most recent snapshot of asset summary values for the snapshot request. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reportAssetSnapshotPayload" /> is null. </exception>
<example>
This sample shows how to call GetSnapshot.
<code><![CDATA[
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);
]]></code>
This sample shows how to call GetSnapshot with all parameters.
<code><![CDATA[
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);
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSnapshot">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetSnapshot (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetSnapshot(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSnapshot(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSnapshot (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member GetSnapshot : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.GetSnapshot : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetSnapshot (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get the most recent snapshot of asset summary values for the snapshot request.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSnapshot(Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSnapshot and parse the result.
<code><![CDATA[
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());
]]></code>
This sample shows how to call GetSnapshot with all request content and parse the result.
<code><![CDATA[
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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSnapshotAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>> GetSnapshotAsync (Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload reportAssetSnapshotPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>> GetSnapshotAsync(class Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload reportAssetSnapshotPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSnapshotAsync(Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSnapshotAsync (reportAssetSnapshotPayload As ReportAssetSnapshotPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ReportAssetSnapshotResult))" />
<MemberSignature Language="F#" Value="abstract member GetSnapshotAsync : Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>>
override this.GetSnapshotAsync : Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>>" Usage="easmClient.GetSnapshotAsync (reportAssetSnapshotPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSnapshotResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reportAssetSnapshotPayload" Type="Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="reportAssetSnapshotPayload"> A request body used to retrieve an asset report snapshot. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get the most recent snapshot of asset summary values for the snapshot request. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reportAssetSnapshotPayload" /> is null. </exception>
<example>
This sample shows how to call GetSnapshotAsync.
<code><![CDATA[
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 = await client.GetSnapshotAsync(reportAssetSnapshotPayload);
]]></code>
This sample shows how to call GetSnapshotAsync with all parameters.
<code><![CDATA[
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 = await client.GetSnapshotAsync(reportAssetSnapshotPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSnapshotAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetSnapshotAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetSnapshotAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSnapshotAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSnapshotAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetSnapshotAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSnapshotAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetSnapshotAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get the most recent snapshot of asset summary values for the snapshot request.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSnapshotAsync(Azure.Analytics.Defender.Easm.ReportAssetSnapshotPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSnapshotAsync and parse the result.
<code><![CDATA[
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 = await client.GetSnapshotAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetSnapshotAsync with all request content and parse the result.
<code><![CDATA[
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 = await client.GetSnapshotAsync(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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSummary">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult> GetSummary (Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload reportAssetSummaryPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.ReportAssetSummaryResult> GetSummary(class Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload reportAssetSummaryPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSummary(Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSummary (reportAssetSummaryPayload As ReportAssetSummaryPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReportAssetSummaryResult)" />
<MemberSignature Language="F#" Value="abstract member GetSummary : Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>
override this.GetSummary : Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>" Usage="easmClient.GetSummary (reportAssetSummaryPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reportAssetSummaryPayload" Type="Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="reportAssetSummaryPayload"> A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get asset summary details for the summary request. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reportAssetSummaryPayload" /> is null. </exception>
<example>
This sample shows how to call GetSummary.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
ReportAssetSummaryPayload reportAssetSummaryPayload = new ReportAssetSummaryPayload();
Response<ReportAssetSummaryResult> response = client.GetSummary(reportAssetSummaryPayload);
]]></code>
This sample shows how to call GetSummary with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
ReportAssetSummaryPayload reportAssetSummaryPayload = new ReportAssetSummaryPayload
{
MetricCategories = { "<metricCategories>" },
Metrics = { "<metrics>" },
Filters = { "<filters>" },
GroupBy = "<groupBy>",
SegmentBy = "<segmentBy>",
LabelName = "<labelName>",
};
Response<ReportAssetSummaryResult> response = client.GetSummary(reportAssetSummaryPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSummary">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetSummary (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetSummary(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSummary(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSummary (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member GetSummary : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.GetSummary : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetSummary (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get asset summary details for the summary request.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSummary(Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSummary and parse the result.
<code><![CDATA[
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.GetSummary(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetSummary with all request content and parse the result.
<code><![CDATA[
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
{
metricCategories = new object[]
{
"<metricCategories>"
},
metrics = new object[]
{
"<metrics>"
},
filters = new object[]
{
"<filters>"
},
groupBy = "<groupBy>",
segmentBy = "<segmentBy>",
labelName = "<labelName>",
});
Response response = client.GetSummary(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("updatedAt").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("metricCategory").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("metric").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("filter").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("labelName").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("link").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSummaryAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>> GetSummaryAsync (Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload reportAssetSummaryPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>> GetSummaryAsync(class Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload reportAssetSummaryPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSummaryAsync(Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSummaryAsync (reportAssetSummaryPayload As ReportAssetSummaryPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ReportAssetSummaryResult))" />
<MemberSignature Language="F#" Value="abstract member GetSummaryAsync : Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>>
override this.GetSummaryAsync : Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>>" Usage="easmClient.GetSummaryAsync (reportAssetSummaryPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ReportAssetSummaryResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reportAssetSummaryPayload" Type="Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="reportAssetSummaryPayload"> A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get asset summary details for the summary request. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reportAssetSummaryPayload" /> is null. </exception>
<example>
This sample shows how to call GetSummaryAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
ReportAssetSummaryPayload reportAssetSummaryPayload = new ReportAssetSummaryPayload();
Response<ReportAssetSummaryResult> response = await client.GetSummaryAsync(reportAssetSummaryPayload);
]]></code>
This sample shows how to call GetSummaryAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
ReportAssetSummaryPayload reportAssetSummaryPayload = new ReportAssetSummaryPayload
{
MetricCategories = { "<metricCategories>" },
Metrics = { "<metrics>" },
Filters = { "<filters>" },
GroupBy = "<groupBy>",
SegmentBy = "<segmentBy>",
LabelName = "<labelName>",
};
Response<ReportAssetSummaryResult> response = await client.GetSummaryAsync(reportAssetSummaryPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSummaryAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetSummaryAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetSummaryAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetSummaryAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSummaryAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetSummaryAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSummaryAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetSummaryAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get asset summary details for the summary request.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetSummaryAsync(Azure.Analytics.Defender.Easm.ReportAssetSummaryPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSummaryAsync and parse the result.
<code><![CDATA[
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 = await client.GetSummaryAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetSummaryAsync with all request content and parse the result.
<code><![CDATA[
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
{
metricCategories = new object[]
{
"<metricCategories>"
},
metrics = new object[]
{
"<metrics>"
},
filters = new object[]
{
"<filters>"
},
groupBy = "<groupBy>",
segmentBy = "<segmentBy>",
labelName = "<labelName>",
});
Response response = await client.GetSummaryAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("updatedAt").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("metricCategory").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("metric").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("filter").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("labelName").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("assetSummaries")[0].GetProperty("link").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTask">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetTask (string taskId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetTask(string taskId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTask(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTask (taskId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetTask : string * Azure.RequestContext -> Azure.Response
override this.GetTask : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.GetTask (taskId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a task by taskId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetTask(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetTask and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetTask("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call GetTask with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.GetTask("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTask">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.TaskResource> GetTask (string taskId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.TaskResource> GetTask(string taskId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTask(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTask (taskId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TaskResource)" />
<MemberSignature Language="F#" Value="abstract member GetTask : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>
override this.GetTask : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>" Usage="easmClient.GetTask (taskId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.TaskResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a task by taskId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetTask.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = client.GetTask("<taskId>");
]]></code>
This sample shows how to call GetTask with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = client.GetTask("<taskId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTaskAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetTaskAsync (string taskId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetTaskAsync(string taskId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTaskAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTaskAsync (taskId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetTaskAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTaskAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.GetTaskAsync (taskId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a task by taskId.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetTaskAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetTaskAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetTaskAsync("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call GetTaskAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.GetTaskAsync("<taskId>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTaskAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>> GetTaskAsync (string taskId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.TaskResource>> GetTaskAsync(string taskId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTaskAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTaskAsync (taskId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TaskResource))" />
<MemberSignature Language="F#" Value="abstract member GetTaskAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>>
override this.GetTaskAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>>" Usage="easmClient.GetTaskAsync (taskId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="taskId"> The unique identifier of the task. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a task by taskId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="taskId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="taskId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetTaskAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = await client.GetTaskAsync("<taskId>");
]]></code>
This sample shows how to call GetTaskAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response<TaskResource> response = await client.GetTaskAsync("<taskId>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTasks">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTasks (string filter, string orderby, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTasks(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTasks(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="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)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetTasks (filter, orderby, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of tasks for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetTasks(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetTasks and parse the result.
<code><![CDATA[
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());
}
]]></code>
This sample shows how to call GetTasks with all parameters and parse the result.
<code><![CDATA[
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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTasks">
<MemberSignature Language="C#" Value="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);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Analytics.Defender.Easm.TaskResource> GetTasks(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTasks(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="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)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.GetTasks (filter, orderby, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Analytics.Defender.Easm.TaskResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of tasks for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetTasks.
<code><![CDATA[
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())
{
}
]]></code>
This sample shows how to call GetTasks with all parameters.
<code><![CDATA[
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))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTasksAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTasksAsync (string filter, string orderby, int? skip, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTasksAsync(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTasksAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTasksAsync (filter As String, orderby As String, skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetTasksAsync : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTasksAsync : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="easmClient.GetTasksAsync (filter, orderby, skip, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Retrieve a list of tasks for the provided search parameters.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.GetTasksAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetTasksAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetTasksAsync(null, null, null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
}
]]></code>
This sample shows how to call GetTasksAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (BinaryData item in client.GetTasksAsync("<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());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTasksAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Analytics.Defender.Easm.TaskResource> GetTasksAsync (string filter = default, string orderby = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Analytics.Defender.Easm.TaskResource> GetTasksAsync(string filter, string orderby, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.GetTasksAsync(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTasksAsync (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 AsyncPageable(Of TaskResource)" />
<MemberSignature Language="F#" Value="abstract member GetTasksAsync : string * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.TaskResource>
override this.GetTasksAsync : string * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Analytics.Defender.Easm.TaskResource>" Usage="easmClient.GetTasksAsync (filter, orderby, skip, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Analytics.Defender.Easm.TaskResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter the result list using the given expression. </param>
<param name="orderby"> A list of expressions that specify the order of the returned resources. </param>
<param name="skip"> The number of result items to skip. </param>
<param name="maxpagesize"> The maximum number of result items per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Retrieve a list of tasks for the provided search parameters. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetTasksAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (TaskResource item in client.GetTasksAsync())
{
}
]]></code>
This sample shows how to call GetTasksAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
await foreach (TaskResource item in client.GetTasksAsync(filter: "<filter>", orderby: "<orderby>", skip: 1234, maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="Pipeline">
<MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Defender.Easm.EasmClient.Pipeline" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" />
<MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.Analytics.Defender.Easm.EasmClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType>
</ReturnValue>
<Docs>
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RunDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response RunDiscoveryGroup (string groupName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RunDiscoveryGroup(string groupName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.RunDiscoveryGroup(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function RunDiscoveryGroup (groupName As String, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member RunDiscoveryGroup : string * Azure.RequestContext -> Azure.Response
override this.RunDiscoveryGroup : string * Azure.RequestContext -> Azure.Response" Usage="easmClient.RunDiscoveryGroup (groupName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Run a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call RunDiscoveryGroup.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.RunDiscoveryGroup("<groupName>");
Console.WriteLine(response.Status);
]]></code>
This sample shows how to call RunDiscoveryGroup with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = client.RunDiscoveryGroup("<groupName>");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="RunDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RunDiscoveryGroupAsync (string groupName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RunDiscoveryGroupAsync(string groupName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.RunDiscoveryGroupAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function RunDiscoveryGroupAsync (groupName As String, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member RunDiscoveryGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RunDiscoveryGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.RunDiscoveryGroupAsync (groupName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="groupName"> The caller provided unique name for the resource. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Run a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="groupName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="groupName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call RunDiscoveryGroupAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.RunDiscoveryGroupAsync("<groupName>");
Console.WriteLine(response.Status);
]]></code>
This sample shows how to call RunDiscoveryGroupAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
Response response = await client.RunDiscoveryGroupAsync("<groupName>");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="UpdateAssets">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.TaskResource> UpdateAssets (string filter, Azure.Analytics.Defender.Easm.AssetUpdatePayload assetUpdatePayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.TaskResource> UpdateAssets(string filter, class Azure.Analytics.Defender.Easm.AssetUpdatePayload assetUpdatePayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.UpdateAssets(System.String,Azure.Analytics.Defender.Easm.AssetUpdatePayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAssets (filter As String, assetUpdatePayload As AssetUpdatePayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TaskResource)" />
<MemberSignature Language="F#" Value="abstract member UpdateAssets : string * Azure.Analytics.Defender.Easm.AssetUpdatePayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>
override this.UpdateAssets : string * Azure.Analytics.Defender.Easm.AssetUpdatePayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>" Usage="easmClient.UpdateAssets (filter, assetUpdatePayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.TaskResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="assetUpdatePayload" Type="Azure.Analytics.Defender.Easm.AssetUpdatePayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> An expression on the resource type that selects the resources to be returned. </param>
<param name="assetUpdatePayload"> A request body used to update an asset. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Update labels on assets matching the provided filter. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filter" /> or <paramref name="assetUpdatePayload" /> is null. </exception>
<example>
This sample shows how to call UpdateAssets.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
AssetUpdatePayload assetUpdatePayload = new AssetUpdatePayload();
Response<TaskResource> response = client.UpdateAssets("<filter>", assetUpdatePayload);
]]></code>
This sample shows how to call UpdateAssets with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
AssetUpdatePayload assetUpdatePayload = new AssetUpdatePayload
{
State = AssetUpdateState.Candidate,
ExternalId = "<externalId>",
Labels =
{
["key"] = true
},
Transfers = AssetUpdateTransfers.As,
};
Response<TaskResource> response = client.UpdateAssets("<filter>", assetUpdatePayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="UpdateAssets">
<MemberSignature Language="C#" Value="public virtual Azure.Response UpdateAssets (string filter, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateAssets(string filter, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.UpdateAssets(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAssets (filter As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member UpdateAssets : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateAssets : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.UpdateAssets (filter, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> An expression on the resource type that selects the resources to be returned. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Update labels on assets matching the provided filter.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.UpdateAssets(System.String,Azure.Analytics.Defender.Easm.AssetUpdatePayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filter" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call UpdateAssets and parse the result.
<code><![CDATA[
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.UpdateAssets("<filter>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call UpdateAssets with all parameters and request content and parse the result.
<code><![CDATA[
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
{
state = "candidate",
externalId = "<externalId>",
labels = new
{
key = true,
},
transfers = "as",
});
Response response = client.UpdateAssets("<filter>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="UpdateAssetsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>> UpdateAssetsAsync (string filter, Azure.Analytics.Defender.Easm.AssetUpdatePayload assetUpdatePayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.TaskResource>> UpdateAssetsAsync(string filter, class Azure.Analytics.Defender.Easm.AssetUpdatePayload assetUpdatePayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.UpdateAssetsAsync(System.String,Azure.Analytics.Defender.Easm.AssetUpdatePayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAssetsAsync (filter As String, assetUpdatePayload As AssetUpdatePayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TaskResource))" />
<MemberSignature Language="F#" Value="abstract member UpdateAssetsAsync : string * Azure.Analytics.Defender.Easm.AssetUpdatePayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>>
override this.UpdateAssetsAsync : string * Azure.Analytics.Defender.Easm.AssetUpdatePayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>>" Usage="easmClient.UpdateAssetsAsync (filter, assetUpdatePayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.TaskResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="assetUpdatePayload" Type="Azure.Analytics.Defender.Easm.AssetUpdatePayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> An expression on the resource type that selects the resources to be returned. </param>
<param name="assetUpdatePayload"> A request body used to update an asset. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Update labels on assets matching the provided filter. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filter" /> or <paramref name="assetUpdatePayload" /> is null. </exception>
<example>
This sample shows how to call UpdateAssetsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
AssetUpdatePayload assetUpdatePayload = new AssetUpdatePayload();
Response<TaskResource> response = await client.UpdateAssetsAsync("<filter>", assetUpdatePayload);
]]></code>
This sample shows how to call UpdateAssetsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
AssetUpdatePayload assetUpdatePayload = new AssetUpdatePayload
{
State = AssetUpdateState.Candidate,
ExternalId = "<externalId>",
Labels =
{
["key"] = true
},
Transfers = AssetUpdateTransfers.As,
};
Response<TaskResource> response = await client.UpdateAssetsAsync("<filter>", assetUpdatePayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="UpdateAssetsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateAssetsAsync (string filter, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateAssetsAsync(string filter, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.UpdateAssetsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAssetsAsync (filter As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member UpdateAssetsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateAssetsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.UpdateAssetsAsync (filter, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> An expression on the resource type that selects the resources to be returned. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Update labels on assets matching the provided filter.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.UpdateAssetsAsync(System.String,Azure.Analytics.Defender.Easm.AssetUpdatePayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filter" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call UpdateAssetsAsync and parse the result.
<code><![CDATA[
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 = await client.UpdateAssetsAsync("<filter>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
]]></code>
This sample shows how to call UpdateAssetsAsync with all parameters and request content and parse the result.
<code><![CDATA[
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
{
state = "candidate",
externalId = "<externalId>",
labels = new
{
key = true,
},
transfers = "as",
});
Response response = await client.UpdateAssetsAsync("<filter>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult> ValidateDataConnection (Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.ValidateResult> ValidateDataConnection(class Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDataConnection(Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDataConnection (dataConnectionPayload As DataConnectionPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ValidateResult)" />
<MemberSignature Language="F#" Value="abstract member ValidateDataConnection : Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>
override this.ValidateDataConnection : Azure.Analytics.Defender.Easm.DataConnectionPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>" Usage="easmClient.ValidateDataConnection (dataConnectionPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionPayload" Type="Azure.Analytics.Defender.Easm.DataConnectionPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="dataConnectionPayload"> The <see cref="T:Azure.Analytics.Defender.Easm.DataConnectionPayload" /> to use. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Validate a data connection with a given dataConnectionName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionPayload" /> is null. </exception>
<example>
This sample shows how to call ValidateDataConnection.
<code><![CDATA[
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 = client.ValidateDataConnection(dataConnectionPayload);
]]></code>
This sample shows how to call ValidateDataConnection with all parameters.
<code><![CDATA[
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 = client.ValidateDataConnection(dataConnectionPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDataConnection">
<MemberSignature Language="C#" Value="public virtual Azure.Response ValidateDataConnection (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response ValidateDataConnection(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDataConnection(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDataConnection (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member ValidateDataConnection : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.ValidateDataConnection : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.ValidateDataConnection (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Validate a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDataConnection(Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call ValidateDataConnection and parse the result.
<code><![CDATA[
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 = client.ValidateDataConnection(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call ValidateDataConnection with all request content and parse the result.
<code><![CDATA[
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 = client.ValidateDataConnection(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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDataConnectionAsync">
<MemberSignature Language="C#" Value="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);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.ValidateResult>> ValidateDataConnectionAsync(class Azure.Analytics.Defender.Easm.DataConnectionPayload dataConnectionPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDataConnectionAsync(Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDataConnectionAsync (dataConnectionPayload As DataConnectionPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ValidateResult))" />
<MemberSignature Language="F#" Value="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>>" Usage="easmClient.ValidateDataConnectionAsync (dataConnectionPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataConnectionPayload" Type="Azure.Analytics.Defender.Easm.DataConnectionPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="dataConnectionPayload"> The <see cref="T:Azure.Analytics.Defender.Easm.DataConnectionPayload" /> to use. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Validate a data connection with a given dataConnectionName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dataConnectionPayload" /> is null. </exception>
<example>
This sample shows how to call ValidateDataConnectionAsync.
<code><![CDATA[
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);
]]></code>
This sample shows how to call ValidateDataConnectionAsync with all parameters.
<code><![CDATA[
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);
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDataConnectionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> ValidateDataConnectionAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> ValidateDataConnectionAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDataConnectionAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDataConnectionAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="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>" Usage="easmClient.ValidateDataConnectionAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Validate a data connection with a given dataConnectionName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDataConnectionAsync(Azure.Analytics.Defender.Easm.DataConnectionPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call ValidateDataConnectionAsync and parse the result.
<code><![CDATA[
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());
]]></code>
This sample shows how to call ValidateDataConnectionAsync with all request content and parse the result.
<code><![CDATA[
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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult> ValidateDiscoveryGroup (Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Defender.Easm.ValidateResult> ValidateDiscoveryGroup(class Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDiscoveryGroup(Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDiscoveryGroup (discoveryGroupPayload As DiscoveryGroupPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ValidateResult)" />
<MemberSignature Language="F#" Value="abstract member ValidateDiscoveryGroup : Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>
override this.ValidateDiscoveryGroup : Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>" Usage="easmClient.ValidateDiscoveryGroup (discoveryGroupPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="discoveryGroupPayload" Type="Azure.Analytics.Defender.Easm.DiscoveryGroupPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="discoveryGroupPayload"> A request body used to create a discovery group. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Validate a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="discoveryGroupPayload" /> is null. </exception>
<example>
This sample shows how to call ValidateDiscoveryGroup.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload();
Response<ValidateResult> response = client.ValidateDiscoveryGroup(discoveryGroupPayload);
]]></code>
This sample shows how to call ValidateDiscoveryGroup with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload
{
Name = "<name>",
Description = "<description>",
Tier = "<tier>",
FrequencyMilliseconds = 1234L,
Seeds = {new DiscoverySource
{
Kind = DiscoverySourceKind.As,
Name = "<name>",
}},
Names = { "<names>" },
Excludes = { default },
TemplateId = "<templateId>",
};
Response<ValidateResult> response = client.ValidateDiscoveryGroup(discoveryGroupPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDiscoveryGroup">
<MemberSignature Language="C#" Value="public virtual Azure.Response ValidateDiscoveryGroup (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response ValidateDiscoveryGroup(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDiscoveryGroup(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDiscoveryGroup (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member ValidateDiscoveryGroup : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.ValidateDiscoveryGroup : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="easmClient.ValidateDiscoveryGroup (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Validate a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDiscoveryGroup(Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call ValidateDiscoveryGroup and parse the result.
<code><![CDATA[
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.ValidateDiscoveryGroup(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call ValidateDiscoveryGroup with all request content and parse the result.
<code><![CDATA[
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
{
name = "<name>",
description = "<description>",
tier = "<tier>",
frequencyMilliseconds = 1234L,
seeds = new object[]
{
new
{
kind = "as",
name = "<name>",
}
},
names = new object[]
{
"<names>"
},
excludes = new object[]
{
null
},
templateId = "<templateId>",
});
Response response = client.ValidateDiscoveryGroup(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());
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>> ValidateDiscoveryGroupAsync (Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Defender.Easm.ValidateResult>> ValidateDiscoveryGroupAsync(class Azure.Analytics.Defender.Easm.DiscoveryGroupPayload discoveryGroupPayload, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDiscoveryGroupAsync(Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDiscoveryGroupAsync (discoveryGroupPayload As DiscoveryGroupPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ValidateResult))" />
<MemberSignature Language="F#" Value="abstract member ValidateDiscoveryGroupAsync : Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>>
override this.ValidateDiscoveryGroupAsync : Azure.Analytics.Defender.Easm.DiscoveryGroupPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>>" Usage="easmClient.ValidateDiscoveryGroupAsync (discoveryGroupPayload, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Defender.Easm.ValidateResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="discoveryGroupPayload" Type="Azure.Analytics.Defender.Easm.DiscoveryGroupPayload" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="discoveryGroupPayload"> A request body used to create a discovery group. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Validate a discovery group with a given groupName. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="discoveryGroupPayload" /> is null. </exception>
<example>
This sample shows how to call ValidateDiscoveryGroupAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload();
Response<ValidateResult> response = await client.ValidateDiscoveryGroupAsync(discoveryGroupPayload);
]]></code>
This sample shows how to call ValidateDiscoveryGroupAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
EasmClient client = new EasmClient(endpoint, credential);
DiscoveryGroupPayload discoveryGroupPayload = new DiscoveryGroupPayload
{
Name = "<name>",
Description = "<description>",
Tier = "<tier>",
FrequencyMilliseconds = 1234L,
Seeds = {new DiscoverySource
{
Kind = DiscoverySourceKind.As,
Name = "<name>",
}},
Names = { "<names>" },
Excludes = { default },
TemplateId = "<templateId>",
};
Response<ValidateResult> response = await client.ValidateDiscoveryGroupAsync(discoveryGroupPayload);
]]></code></example>
</Docs>
</Member>
<Member MemberName="ValidateDiscoveryGroupAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> ValidateDiscoveryGroupAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> ValidateDiscoveryGroupAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDiscoveryGroupAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateDiscoveryGroupAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member ValidateDiscoveryGroupAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.ValidateDiscoveryGroupAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="easmClient.ValidateDiscoveryGroupAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Defender.Easm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Validate a discovery group with a given groupName.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Analytics.Defender.Easm.EasmClient.ValidateDiscoveryGroupAsync(Azure.Analytics.Defender.Easm.DiscoveryGroupPayload,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call ValidateDiscoveryGroupAsync and parse the result.
<code><![CDATA[
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 = await client.ValidateDiscoveryGroupAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call ValidateDiscoveryGroupAsync with all request content and parse the result.
<code><![CDATA[
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
{
name = "<name>",
description = "<description>",
tier = "<tier>",
frequencyMilliseconds = 1234L,
seeds = new object[]
{
new
{
kind = "as",
name = "<name>",
}
},
names = new object[]
{
"<names>"
},
excludes = new object[]
{
null
},
templateId = "<templateId>",
});
Response response = await client.ValidateDiscoveryGroupAsync(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());
]]></code></example>
</Docs>
</Member>
</Members>
</Type>