azure_traffic_collectors

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

Overview

Name	azure_traffic_collectors
Type	Resource
Id	azure.network_function.azure_traffic_collectors

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting Azure Traffic Collector 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 Azure Traffic Collector.
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		Gets the specified Azure Traffic Collector in a specified resource group
create_or_update	insert	resourceGroupName, subscriptionId, azureTrafficCollectorName		Creates or updates a Azure Traffic Collector resource
delete	delete	resourceGroupName, subscriptionId, azureTrafficCollectorName		Deletes a specified Azure Traffic Collector resource.
update_tags	exec	resourceGroupName, subscriptionId, azureTrafficCollectorName		Updates the specified Azure Traffic Collector 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
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets the specified Azure Traffic Collector in a specified resource group

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

INSERT examples

create_or_update

Creates or updates a Azure Traffic Collector resource

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

Manifest

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

DELETE examples

delete

Deletes a specified Azure Traffic Collector resource.

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

Lifecycle Methods

update_tags

Updates the specified Azure Traffic Collector tags.

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