EasmClient.CreateOrReplaceSavedFilter Method

  • Reference

Definition

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

Overloads

CreateOrReplaceSavedFilter(String, SavedFilterPayload, CancellationToken)

Create or replace a saved filter with a given filterName.
CreateOrReplaceSavedFilter(String, RequestContent, RequestContext)

[Protocol Method] Create or replace a saved filter with a given filterName.

CreateOrReplaceSavedFilter(String, SavedFilterPayload, CancellationToken)

Source:
EasmClient.cs

Create or replace a saved filter with a given filterName.

public virtual Azure.Response<Azure.Analytics.Defender.Easm.SavedFilter> CreateOrReplaceSavedFilter (string filterName, Azure.Analytics.Defender.Easm.SavedFilterPayload savedFilterPayload, System.Threading.CancellationToken cancellationToken = default);
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>
Public Overridable Function CreateOrReplaceSavedFilter (filterName As String, savedFilterPayload As SavedFilterPayload, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SavedFilter)

Parameters

filterName
String

The caller provided unique name for the resource.

savedFilterPayload
SavedFilterPayload

A request body used to create a saved filter.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<SavedFilter>

Exceptions

ArgumentNullException

filterName or savedFilterPayload is null.

ArgumentException

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

Examples

This sample shows how to call CreateOrReplaceSavedFilter.

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);

This sample shows how to call CreateOrReplaceSavedFilter with all parameters.

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);

Applies to

CreateOrReplaceSavedFilter(String, RequestContent, RequestContext)

Source:
EasmClient.cs

[Protocol Method] Create or replace a saved filter with a given filterName.

public virtual Azure.Response CreateOrReplaceSavedFilter (string filterName, Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member CreateOrReplaceSavedFilter : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateOrReplaceSavedFilter : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
Public Overridable Function CreateOrReplaceSavedFilter (filterName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

filterName
String

The caller provided unique name for the resource.

content
RequestContent

The content to send as the body of the request.

context
RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

filterName or content is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Examples

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

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

using RequestContent content = RequestContent.Create(new
{
    filter = "<filter>",
    description = "<description>",
});
Response response = client.CreateOrReplaceSavedFilter("<filterName>", content);

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

This sample shows how to call CreateOrReplaceSavedFilter with all parameters and request content and parse the result.

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

using RequestContent content = RequestContent.Create(new
{
    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());

Applies to