Entities interface

Package:

@azure/arm-securityinsight

Interface representing a Entities.

Methods

expand(string, string, string, EntityExpandParameters, EntitiesExpandOptionalParams)	Expands an entity.
get(string, string, string, EntitiesGetOptionalParams)	Gets an entity.
getInsights(string, string, string, EntityGetInsightsParameters, EntitiesGetInsightsOptionalParams)	Execute Insights for an entity.
list(string, string, EntitiesListOptionalParams)	Gets all entities.
queries(string, string, string, string, EntitiesQueriesOptionalParams)	Get Insights and Activities for an entity.

Method Details

expand(string, string, string, EntityExpandParameters, EntitiesExpandOptionalParams)

Expands an entity.

function expand(resourceGroupName: string, workspaceName: string, entityId: string, parameters: EntityExpandParameters, options?: EntitiesExpandOptionalParams): Promise<EntityExpandResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

entityId

string

entity ID

parameters

EntityExpandParameters

The parameters required to execute an expand operation on the given entity.

options

EntitiesExpandOptionalParams

The options parameters.

Returns

Promise<EntityExpandResponse>

get(string, string, string, EntitiesGetOptionalParams)

Gets an entity.

function get(resourceGroupName: string, workspaceName: string, entityId: string, options?: EntitiesGetOptionalParams): Promise<EntityUnion>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

entityId

string

entity ID

options

EntitiesGetOptionalParams

The options parameters.

Returns

Promise<EntityUnion>

getInsights(string, string, string, EntityGetInsightsParameters, EntitiesGetInsightsOptionalParams)

Execute Insights for an entity.

function getInsights(resourceGroupName: string, workspaceName: string, entityId: string, parameters: EntityGetInsightsParameters, options?: EntitiesGetInsightsOptionalParams): Promise<EntityGetInsightsResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

entityId

string

entity ID

parameters

EntityGetInsightsParameters

The parameters required to execute insights on the given entity.

options

EntitiesGetInsightsOptionalParams

The options parameters.

Returns

Promise<EntityGetInsightsResponse>

list(string, string, EntitiesListOptionalParams)

Gets all entities.

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

EntitiesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EntityUnion, EntityUnion[], PageSettings>

queries(string, string, string, string, EntitiesQueriesOptionalParams)

Get Insights and Activities for an entity.

function queries(resourceGroupName: string, workspaceName: string, entityId: string, kind: string, options?: EntitiesQueriesOptionalParams): Promise<GetQueriesResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

entityId

string

entity ID

kind

string

The Kind parameter for queries

options

EntitiesQueriesOptionalParams

The options parameters.

Returns

Promise<GetQueriesResponse>