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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
emissionPolicies	array	Emission policies.
etag	string	A unique read-only string that changes whenever the resource is updated.
ingestionPolicy	object	Ingestion policies.
location	string	Resource location. Required.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Updating", "Deleting", and "Failed". (Succeeded, Updating, Deleting, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
emissionPolicies	array	Emission policies.
etag	string	A unique read-only string that changes whenever the resource is updated.
ingestionPolicy	object	Ingestion policies.
location	string	Resource location. Required.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Updating", "Deleting", and "Failed". (Succeeded, Updating, Deleting, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, azure_traffic_collector_name, collector_policy_name, subscription_id		Gets the collector policy in a specified Traffic Collector.
list	select	resource_group_name, azure_traffic_collector_name, subscription_id		Return list of Collector policies in a Azure Traffic Collector.
create_or_update	insert	resource_group_name, azure_traffic_collector_name, collector_policy_name, subscription_id, location		Creates or updates a Collector Policy resource.
update_tags	update	resource_group_name, azure_traffic_collector_name, collector_policy_name, subscription_id		Updates the specified Collector Policy tags.
create_or_update	replace	resource_group_name, azure_traffic_collector_name, collector_policy_name, subscription_id, location		Creates or updates a Collector Policy resource.
delete	delete	resource_group_name, azure_traffic_collector_name, collector_policy_name, subscription_id		Deletes a specified Collector Policy resource.

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
azure_traffic_collector_name	string	Azure Traffic Collector name. Required.
collector_policy_name	string	Collector Policy Name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the collector policy in a specified Traffic Collector.

SELECT
id,
name,
emissionPolicies,
etag,
ingestionPolicy,
location,
provisioningState,
systemData,
tags,
type
FROM azure.network_function.collector_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_traffic_collector_name = '{{ azure_traffic_collector_name }}' -- required
AND collector_policy_name = '{{ collector_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Return list of Collector policies in a Azure Traffic Collector.

SELECT
id,
name,
emissionPolicies,
etag,
ingestionPolicy,
location,
provisioningState,
systemData,
tags,
type
FROM azure.network_function.collector_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_traffic_collector_name = '{{ azure_traffic_collector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Collector Policy resource.

INSERT INTO azure.network_function.collector_policies (
properties,
location,
tags,
resource_group_name,
azure_traffic_collector_name,
collector_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ resource_group_name }}',
'{{ azure_traffic_collector_name }}',
'{{ collector_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: collector_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the collector_policies resource.
  - name: azure_traffic_collector_name
    value: "{{ azure_traffic_collector_name }}"
    description: Required parameter for the collector_policies resource.
  - name: collector_policy_name
    value: "{{ collector_policy_name }}"
    description: Required parameter for the collector_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the collector_policies resource.
  - name: properties
    description: |
      Properties of the Collector Policy.
    value:
      ingestionPolicy:
        ingestionType: "{{ ingestionType }}"
        ingestionSources:
          - sourceType: "{{ sourceType }}"
            resourceId: "{{ resourceId }}"
      emissionPolicies:
        - emissionType: "{{ emissionType }}"
          emissionDestinations: "{{ emissionDestinations }}"
      provisioningState: "{{ provisioningState }}"
  - name: location
    value: "{{ location }}"
    description: |
      Resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

UPDATE examples

update_tags

Updates the specified Collector Policy tags.

UPDATE azure.network_function.collector_policies
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_traffic_collector_name = '{{ azure_traffic_collector_name }}' --required
AND collector_policy_name = '{{ collector_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Collector Policy resource.

REPLACE azure.network_function.collector_policies
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_traffic_collector_name = '{{ azure_traffic_collector_name }}' --required
AND collector_policy_name = '{{ collector_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a specified Collector Policy resource.

DELETE FROM azure.network_function.collector_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND azure_traffic_collector_name = '{{ azure_traffic_collector_name }}' --required
AND collector_policy_name = '{{ collector_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;