Skip to main content

azure_traffic_collectors_by_subscription

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

Overview

Nameazure_traffic_collectors_by_subscription
TypeResource
Idazure.network_function.azure_traffic_collectors_by_subscription

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
collectorPoliciesarrayCollector Policies for Azure Traffic Collector.
etagstringA unique read-only string that changes whenever the resource is updated.
locationstringResource location. Required.
provisioningStatestringThe provisioning state of the application rule collection resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed". (Succeeded, Updating, Deleting, Failed)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualHubobjectResource reference properties.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectsubscription_idReturn list of Azure Traffic Collectors in a subscription.

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.

NameDatatypeDescription
subscription_idstring

SELECT examples

Return list of Azure Traffic Collectors in a subscription.

SELECT
id,
name,
collectorPolicies,
etag,
location,
provisioningState,
systemData,
tags,
type,
virtualHub
FROM azure.network_function.azure_traffic_collectors_by_subscription
WHERE subscription_id = '{{ subscription_id }}' -- required
;