CollectorPolicies interface

Package:

@azure/arm-networkfunction

Interface representing a CollectorPolicies.

Methods

beginCreateOrUpdate(string, string, string, string, CollectorPoliciesCreateOrUpdateOptionalParams)	Creates or updates a Collector Policy resource
beginCreateOrUpdateAndWait(string, string, string, string, CollectorPoliciesCreateOrUpdateOptionalParams)	Creates or updates a Collector Policy resource
beginDelete(string, string, string, CollectorPoliciesDeleteOptionalParams)	Deletes a specified Collector Policy resource.
beginDeleteAndWait(string, string, string, CollectorPoliciesDeleteOptionalParams)	Deletes a specified Collector Policy resource.
get(string, string, string, CollectorPoliciesGetOptionalParams)	Gets the collector policy in a specified Traffic Collector
list(string, string, CollectorPoliciesListOptionalParams)	Return list of Collector policies in a Azure Traffic Collector
updateTags(string, string, string, TagsObject, CollectorPoliciesUpdateTagsOptionalParams)	Updates the specified Collector Policy tags.

Method Details

beginCreateOrUpdate(string, string, string, string, CollectorPoliciesCreateOrUpdateOptionalParams)

Creates or updates a Collector Policy resource

function beginCreateOrUpdate(resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, location: string, options?: CollectorPoliciesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CollectorPolicy>, CollectorPolicy>>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

collectorPolicyName

string

Collector Policy Name

location

string

Resource location.

options

CollectorPoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<CollectorPolicy>, CollectorPolicy>>

beginCreateOrUpdateAndWait(string, string, string, string, CollectorPoliciesCreateOrUpdateOptionalParams)

Creates or updates a Collector Policy resource

function beginCreateOrUpdateAndWait(resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, location: string, options?: CollectorPoliciesCreateOrUpdateOptionalParams): Promise<CollectorPolicy>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

collectorPolicyName

string

Collector Policy Name

location

string

Resource location.

options

CollectorPoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CollectorPolicy>

beginDelete(string, string, string, CollectorPoliciesDeleteOptionalParams)

Deletes a specified Collector Policy resource.

function beginDelete(resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

collectorPolicyName

string

Collector Policy Name

options

CollectorPoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, CollectorPoliciesDeleteOptionalParams)

Deletes a specified Collector Policy resource.

function beginDeleteAndWait(resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

collectorPolicyName

string

Collector Policy Name

options

CollectorPoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, CollectorPoliciesGetOptionalParams)

Gets the collector policy in a specified Traffic Collector

function get(resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesGetOptionalParams): Promise<CollectorPolicy>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

collectorPolicyName

string

Collector Policy Name

options

CollectorPoliciesGetOptionalParams

The options parameters.

Returns

Promise<CollectorPolicy>

list(string, string, CollectorPoliciesListOptionalParams)

Return list of Collector policies in a Azure Traffic Collector

function list(resourceGroupName: string, azureTrafficCollectorName: string, options?: CollectorPoliciesListOptionalParams): PagedAsyncIterableIterator<CollectorPolicy, CollectorPolicy[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

options

CollectorPoliciesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CollectorPolicy, CollectorPolicy[], PageSettings>

updateTags(string, string, string, TagsObject, CollectorPoliciesUpdateTagsOptionalParams)

Updates the specified Collector Policy tags.

function updateTags(resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, parameters: TagsObject, options?: CollectorPoliciesUpdateTagsOptionalParams): Promise<CollectorPolicy>

Parameters

resourceGroupName

string

The name of the resource group.

azureTrafficCollectorName

string

Azure Traffic Collector name

collectorPolicyName

string

Collector Policy Name

parameters

TagsObject

Parameters supplied to update Collector Policy tags.

options

CollectorPoliciesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<CollectorPolicy>