EntitiesOperations interface

Package:

@azure/arm-securityinsight

Interface representing a Entities operations.

Properties

expand	Expands an entity.
get	Gets an entity.
getInsights	Execute Insights for an entity.
list	Gets all entities.
queries	Get Insights and Activities for an entity.
runPlaybook	Triggers playbook on a specific entity.

Property Details

expand

Expands an entity.

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

Property Value

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

get

Gets an entity.

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

Property Value

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

getInsights

Execute Insights for an entity.

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

Property Value

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

list

Gets all entities.

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

Property Value

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

queries

Get Insights and Activities for an entity.

queries: (resourceGroupName: string, workspaceName: string, entityId: string, kind: string, options?: EntitiesQueriesOptionalParams) => PagedAsyncIterableIterator<EntityQueryItemUnion, EntityQueryItemUnion[], PageSettings>

Property Value

(resourceGroupName: string, workspaceName: string, entityId: string, kind: string, options?: EntitiesQueriesOptionalParams) => PagedAsyncIterableIterator<EntityQueryItemUnion, EntityQueryItemUnion[], PageSettings>

runPlaybook

Triggers playbook on a specific entity.

runPlaybook: (resourceGroupName: string, workspaceName: string, entityIdentifier: string, options?: EntitiesRunPlaybookOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, entityIdentifier: string, options?: EntitiesRunPlaybookOptionalParams) => Promise<void>