Share via

EntityQueries interface

  • Reference
Package:
@azure/arm-securityinsight

Interface representing a EntityQueries.

Methods

createOrUpdate(string, string, string, CustomEntityQueryUnion, EntityQueriesCreateOrUpdateOptionalParams)

Creates or updates the entity query.
delete(string, string, string, EntityQueriesDeleteOptionalParams)

Delete the entity query.
get(string, string, string, EntityQueriesGetOptionalParams)

Gets an entity query.
list(string, string, EntityQueriesListOptionalParams)

Gets all entity queries.

Method Details

createOrUpdate(string, string, string, CustomEntityQueryUnion, EntityQueriesCreateOrUpdateOptionalParams)

Creates or updates the entity query.

function createOrUpdate(resourceGroupName: string, workspaceName: string, entityQueryId: string, entityQuery: CustomEntityQueryUnion, options?: EntityQueriesCreateOrUpdateOptionalParams): Promise<EntityQueryUnion>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

entityQueryId

string

entity query ID

entityQuery
CustomEntityQueryUnion

The entity query we want to create or update

options
EntityQueriesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EntityQueryUnion>

delete(string, string, string, EntityQueriesDeleteOptionalParams)

Delete the entity query.

function delete(resourceGroupName: string, workspaceName: string, entityQueryId: string, options?: EntityQueriesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

entityQueryId

string

entity query ID

options
EntityQueriesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, EntityQueriesGetOptionalParams)

Gets an entity query.

function get(resourceGroupName: string, workspaceName: string, entityQueryId: string, options?: EntityQueriesGetOptionalParams): Promise<EntityQueryUnion>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

entityQueryId

string

entity query ID

options
EntityQueriesGetOptionalParams

The options parameters.

Returns

Promise<EntityQueryUnion>

list(string, string, EntityQueriesListOptionalParams)

Gets all entity queries.

function list(resourceGroupName: string, workspaceName: string, options?: EntityQueriesListOptionalParams): PagedAsyncIterableIterator<EntityQueryUnion, EntityQueryUnion[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

options
EntityQueriesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EntityQueryUnion, EntityQueryUnion[], PageSettings>