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

vw_collector_policies

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
azureTrafficCollectorName	text	field from the properties object
collectorPolicyName	text	field from the properties object
emission_policies	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
ingestion_policy	text	field from the properties object
location	text	Resource location.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.

collector_policies

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	Collection policy properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.

Methods

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

SELECT examples

Return list of Collector policies in a Azure Traffic Collector

vw_collector_policies

SELECT
id,
name,
azureTrafficCollectorName,
collectorPolicyName,
emission_policies,
etag,
ingestion_policy,
location,
provisioning_state,
resourceGroupName,
subscriptionId,
system_data,
tags,
type
FROM azure.network_function.vw_collector_policies
WHERE azureTrafficCollectorName = '{{ azureTrafficCollectorName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

collector_policies

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

INSERT example

Use the following StackQL query and manifest file to create a new collector_policies resource.

All Properties

/*+ create */
INSERT INTO azure.network_function.collector_policies (
azureTrafficCollectorName,
collectorPolicyName,
resourceGroupName,
subscriptionId,
properties,
location,
tags
)
SELECT 
'{{ azureTrafficCollectorName }}',
'{{ collectorPolicyName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: ingestionPolicy
          value:
            - name: ingestionType
              value: string
            - name: ingestionSources
              value:
                - - name: sourceType
                    value: string
                  - name: resourceId
                    value: string
        - name: emissionPolicies
          value:
            - - name: emissionType
                value: string
              - name: emissionDestinations
                value:
                  - - name: destinationType
                      value: string
        - name: provisioningState
          value: []
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: systemData
      value: string

DELETE example

Deletes the specified collector_policies resource.

/*+ delete */
DELETE FROM azure.network_function.collector_policies
WHERE azureTrafficCollectorName = '{{ azureTrafficCollectorName }}'
AND collectorPolicyName = '{{ collectorPolicyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';