SummaryLogsOperations interface

Package:

@azure/arm-operationalinsights

Interface representing a SummaryLogsOperations.

Methods

beginCreateOrUpdate(string, string, string, SummaryLogs, SummaryLogsCreateOrUpdateOptionalParams)	Creates or updates Log Analytics workspace Summary rules.
beginCreateOrUpdateAndWait(string, string, string, SummaryLogs, SummaryLogsCreateOrUpdateOptionalParams)	Creates or updates Log Analytics workspace Summary rules.
beginDelete(string, string, string, SummaryLogsDeleteOptionalParams)	Deletes Log Analytics workspace Summary rules.
beginDeleteAndWait(string, string, string, SummaryLogsDeleteOptionalParams)	Deletes Log Analytics workspace Summary rules.
beginRetryBin(string, string, string, SummaryLogsRetryBin, SummaryLogsRetryBinOptionalParams)	Retries a failed Summary rule bin.
beginRetryBinAndWait(string, string, string, SummaryLogsRetryBin, SummaryLogsRetryBinOptionalParams)	Retries a failed Summary rule bin.
beginStart(string, string, string, SummaryLogsStartOptionalParams)	Starts an inactive Summary rule.
beginStartAndWait(string, string, string, SummaryLogsStartOptionalParams)	Starts an inactive Summary rule.
get(string, string, string, SummaryLogsGetOptionalParams)	Gets Log Analytics workspace Summary rules.
listByWorkspace(string, string, SummaryLogsListByWorkspaceOptionalParams)	Gets all summary rules for the specified Log Analytics workspace.
stop(string, string, string, SummaryLogsStopOptionalParams)	Stops an active Summary rule.

Method Details

beginCreateOrUpdate(string, string, string, SummaryLogs, SummaryLogsCreateOrUpdateOptionalParams)

Creates or updates Log Analytics workspace Summary rules.

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, summaryLogsName: string, parameters: SummaryLogs, options?: SummaryLogsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SummaryLogsCreateOrUpdateResponse>, SummaryLogsCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

parameters

SummaryLogs

The parameters required to update summary rules properties.

options

SummaryLogsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SummaryLogsCreateOrUpdateResponse>, SummaryLogsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, SummaryLogs, SummaryLogsCreateOrUpdateOptionalParams)

Creates or updates Log Analytics workspace Summary rules.

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, summaryLogsName: string, parameters: SummaryLogs, options?: SummaryLogsCreateOrUpdateOptionalParams): Promise<SummaryLogsCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

parameters

SummaryLogs

The parameters required to update summary rules properties.

options

SummaryLogsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SummaryLogsCreateOrUpdateResponse>

beginDelete(string, string, string, SummaryLogsDeleteOptionalParams)

Deletes Log Analytics workspace Summary rules.

function beginDelete(resourceGroupName: string, workspaceName: string, summaryLogsName: string, options?: SummaryLogsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<SummaryLogsDeleteHeaders>, SummaryLogsDeleteHeaders>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

options

SummaryLogsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SummaryLogsDeleteHeaders>, SummaryLogsDeleteHeaders>>

beginDeleteAndWait(string, string, string, SummaryLogsDeleteOptionalParams)

Deletes Log Analytics workspace Summary rules.

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, summaryLogsName: string, options?: SummaryLogsDeleteOptionalParams): Promise<SummaryLogsDeleteHeaders>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

options

SummaryLogsDeleteOptionalParams

The options parameters.

Returns

Promise<SummaryLogsDeleteHeaders>

beginRetryBin(string, string, string, SummaryLogsRetryBin, SummaryLogsRetryBinOptionalParams)

Retries a failed Summary rule bin.

function beginRetryBin(resourceGroupName: string, workspaceName: string, summaryLogsName: string, parameters: SummaryLogsRetryBin, options?: SummaryLogsRetryBinOptionalParams): Promise<SimplePollerLike<OperationState<SummaryLogsRetryBinHeaders>, SummaryLogsRetryBinHeaders>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

parameters

SummaryLogsRetryBin

The parameters required to retry a Summary rule bin.

options

SummaryLogsRetryBinOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SummaryLogsRetryBinHeaders>, SummaryLogsRetryBinHeaders>>

beginRetryBinAndWait(string, string, string, SummaryLogsRetryBin, SummaryLogsRetryBinOptionalParams)

Retries a failed Summary rule bin.

function beginRetryBinAndWait(resourceGroupName: string, workspaceName: string, summaryLogsName: string, parameters: SummaryLogsRetryBin, options?: SummaryLogsRetryBinOptionalParams): Promise<SummaryLogsRetryBinHeaders>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

parameters

SummaryLogsRetryBin

The parameters required to retry a Summary rule bin.

options

SummaryLogsRetryBinOptionalParams

The options parameters.

Returns

Promise<SummaryLogsRetryBinHeaders>

beginStart(string, string, string, SummaryLogsStartOptionalParams)

Starts an inactive Summary rule.

function beginStart(resourceGroupName: string, workspaceName: string, summaryLogsName: string, options?: SummaryLogsStartOptionalParams): Promise<SimplePollerLike<OperationState<SummaryLogsStartHeaders>, SummaryLogsStartHeaders>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

options

SummaryLogsStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SummaryLogsStartHeaders>, SummaryLogsStartHeaders>>

beginStartAndWait(string, string, string, SummaryLogsStartOptionalParams)

Starts an inactive Summary rule.

function beginStartAndWait(resourceGroupName: string, workspaceName: string, summaryLogsName: string, options?: SummaryLogsStartOptionalParams): Promise<SummaryLogsStartHeaders>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

options

SummaryLogsStartOptionalParams

The options parameters.

Returns

Promise<SummaryLogsStartHeaders>

get(string, string, string, SummaryLogsGetOptionalParams)

Gets Log Analytics workspace Summary rules.

function get(resourceGroupName: string, workspaceName: string, summaryLogsName: string, options?: SummaryLogsGetOptionalParams): Promise<SummaryLogs>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

options

SummaryLogsGetOptionalParams

The options parameters.

Returns

Promise<SummaryLogs>

listByWorkspace(string, string, SummaryLogsListByWorkspaceOptionalParams)

Gets all summary rules for the specified Log Analytics workspace.

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: SummaryLogsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<SummaryLogs, SummaryLogs[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

SummaryLogsListByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SummaryLogs, SummaryLogs[], PageSettings>

stop(string, string, string, SummaryLogsStopOptionalParams)

Stops an active Summary rule.

function stop(resourceGroupName: string, workspaceName: string, summaryLogsName: string, options?: SummaryLogsStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

summaryLogsName

string

The name of the summary logs. Must not contain '/'.

options

SummaryLogsStopOptionalParams

The options parameters.

Returns

Promise<void>