DataCollectionRules interface

Package:

@azure/arm-monitor

Interface representing a DataCollectionRules.

Methods

create(string, string, DataCollectionRulesCreateOptionalParams)	Creates or updates a data collection rule.
delete(string, string, DataCollectionRulesDeleteOptionalParams)	Deletes a data collection rule.
get(string, string, DataCollectionRulesGetOptionalParams)	Returns the specified data collection rule.
listByResourceGroup(string, DataCollectionRulesListByResourceGroupOptionalParams)	Lists all data collection rules in the specified resource group.
listBySubscription(DataCollectionRulesListBySubscriptionOptionalParams)	Lists all data collection rules in the specified subscription.
update(string, string, DataCollectionRulesUpdateOptionalParams)	Updates part of a data collection rule.

Method Details

create(string, string, DataCollectionRulesCreateOptionalParams)

Creates or updates a data collection rule.

function create(resourceGroupName: string, dataCollectionRuleName: string, options?: DataCollectionRulesCreateOptionalParams): Promise<DataCollectionRuleResource>

Parameters

resourceGroupName

string

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

dataCollectionRuleName

string

The name of the data collection rule. The name is case insensitive.

options

DataCollectionRulesCreateOptionalParams

The options parameters.

Returns

Promise<DataCollectionRuleResource>

delete(string, string, DataCollectionRulesDeleteOptionalParams)

Deletes a data collection rule.

function delete(resourceGroupName: string, dataCollectionRuleName: string, options?: DataCollectionRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

dataCollectionRuleName

string

The name of the data collection rule. The name is case insensitive.

options

DataCollectionRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DataCollectionRulesGetOptionalParams)

Returns the specified data collection rule.

function get(resourceGroupName: string, dataCollectionRuleName: string, options?: DataCollectionRulesGetOptionalParams): Promise<DataCollectionRuleResource>

Parameters

resourceGroupName

string

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

dataCollectionRuleName

string

The name of the data collection rule. The name is case insensitive.

options

DataCollectionRulesGetOptionalParams

The options parameters.

Returns

Promise<DataCollectionRuleResource>

listByResourceGroup(string, DataCollectionRulesListByResourceGroupOptionalParams)

Lists all data collection rules in the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: DataCollectionRulesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DataCollectionRuleResource, DataCollectionRuleResource[], PageSettings>

Parameters

resourceGroupName

string

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

options

DataCollectionRulesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DataCollectionRuleResource, DataCollectionRuleResource[], PageSettings>

listBySubscription(DataCollectionRulesListBySubscriptionOptionalParams)

Lists all data collection rules in the specified subscription.

function listBySubscription(options?: DataCollectionRulesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DataCollectionRuleResource, DataCollectionRuleResource[], PageSettings>

Parameters

options

DataCollectionRulesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DataCollectionRuleResource, DataCollectionRuleResource[], PageSettings>

update(string, string, DataCollectionRulesUpdateOptionalParams)

Updates part of a data collection rule.

function update(resourceGroupName: string, dataCollectionRuleName: string, options?: DataCollectionRulesUpdateOptionalParams): Promise<DataCollectionRuleResource>

Parameters

resourceGroupName

string

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

dataCollectionRuleName

string

The name of the data collection rule. The name is case insensitive.

options

DataCollectionRulesUpdateOptionalParams

The options parameters.

Returns

Promise<DataCollectionRuleResource>