azure_traffic_collectors

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

Overview

Name	azure_traffic_collectors
Type	Resource
Id	azure.network_function.azure_traffic_collectors

Fields

vw_azure_traffic_collectors

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
azureTrafficCollectorName	text	field from the properties object
collector_policies	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
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.
virtual_hub	text	field from the properties object

azure_traffic_collectors

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	Azure Traffic Collector resource 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, resourceGroupName, subscriptionId	Gets the specified Azure Traffic Collector in a specified resource group
create_or_update	INSERT	azureTrafficCollectorName, resourceGroupName, subscriptionId	Creates or updates a Azure Traffic Collector resource
delete	DELETE	azureTrafficCollectorName, resourceGroupName, subscriptionId	Deletes a specified Azure Traffic Collector resource.
update_tags	EXEC	azureTrafficCollectorName, resourceGroupName, subscriptionId	Updates the specified Azure Traffic Collector tags.

SELECT examples

Gets the specified Azure Traffic Collector in a specified resource group

vw_azure_traffic_collectors

SELECT
id,
name,
azureTrafficCollectorName,
collector_policies,
etag,
location,
provisioning_state,
resourceGroupName,
subscriptionId,
system_data,
tags,
type,
virtual_hub
FROM azure.network_function.vw_azure_traffic_collectors
WHERE azureTrafficCollectorName = '{{ azureTrafficCollectorName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

azure_traffic_collectors

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: collectorPolicies
          value:
            - - name: id
                value: string
        - name: virtualHub
          value:
            - name: id
              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 azure_traffic_collectors resource.

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