collector_policies

Creates, updates, deletes, gets or lists a collector_policies resource.

Overview

Name	collector_policies
Type	Resource
Id	azure.network_function.collector_policies

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the collector policy resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the Collector Policy.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.

list

Request successful. The operation returns a list of collector policies in a azure traffic collector.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the Collector Policy.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, azureTrafficCollectorName, collectorPolicyName		Gets the collector policy in a specified Traffic Collector
list	select	resourceGroupName, subscriptionId, azureTrafficCollectorName		Return list of Collector policies in a Azure Traffic Collector
create_or_update	insert	resourceGroupName, subscriptionId, azureTrafficCollectorName, collectorPolicyName		Creates or updates a Collector Policy resource
delete	delete	resourceGroupName, subscriptionId, azureTrafficCollectorName, collectorPolicyName		Deletes a specified Collector Policy resource.
update_tags	exec	resourceGroupName, subscriptionId, azureTrafficCollectorName, collectorPolicyName		Updates the specified Collector Policy tags.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
azureTrafficCollectorName	string	Azure Traffic Collector name
collectorPolicyName	string	Collector Policy Name
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets the collector policy in a specified Traffic Collector

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.network_function.collector_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND azureTrafficCollectorName = '{{ azureTrafficCollectorName }}' -- required
AND collectorPolicyName = '{{ collectorPolicyName }}' -- required
;

list

Return list of Collector policies in a Azure Traffic Collector

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.network_function.collector_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND azureTrafficCollectorName = '{{ azureTrafficCollectorName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Collector Policy resource

INSERT INTO azure.network_function.collector_policies (
data__properties,
data__location,
data__tags,
resourceGroupName,
subscriptionId,
azureTrafficCollectorName,
collectorPolicyName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ azureTrafficCollectorName }}',
'{{ collectorPolicyName }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: collector_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the collector_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the collector_policies resource.
    - name: azureTrafficCollectorName
      value: string
      description: Required parameter for the collector_policies resource.
    - name: collectorPolicyName
      value: string
      description: Required parameter for the collector_policies resource.
    - name: properties
      value: object
      description: |
        Properties of the Collector Policy.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

DELETE examples

delete

Deletes a specified Collector Policy resource.

DELETE FROM azure.network_function.collector_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND azureTrafficCollectorName = '{{ azureTrafficCollectorName }}' --required
AND collectorPolicyName = '{{ collectorPolicyName }}' --required
;

Lifecycle Methods

update_tags

Updates the specified Collector Policy tags.

EXEC azure.network_function.collector_policies.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@azureTrafficCollectorName='{{ azureTrafficCollectorName }}' --required, 
@collectorPolicyName='{{ collectorPolicyName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;