Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. networkfunction
  5. getCollectorPolicy
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.networkfunction.getCollectorPolicy

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the collector policy in a specified Traffic Collector

Uses Azure REST API version 2022-11-01.

Using getCollectorPolicy

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCollectorPolicy(args: GetCollectorPolicyArgs, opts?: InvokeOptions): Promise<GetCollectorPolicyResult>
function getCollectorPolicyOutput(args: GetCollectorPolicyOutputArgs, opts?: InvokeOptions): Output<GetCollectorPolicyResult>
Copy
def get_collector_policy(azure_traffic_collector_name: Optional[str] = None,
                         collector_policy_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCollectorPolicyResult
def get_collector_policy_output(azure_traffic_collector_name: Optional[pulumi.Input[str]] = None,
                         collector_policy_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCollectorPolicyResult]
Copy
func LookupCollectorPolicy(ctx *Context, args *LookupCollectorPolicyArgs, opts ...InvokeOption) (*LookupCollectorPolicyResult, error)
func LookupCollectorPolicyOutput(ctx *Context, args *LookupCollectorPolicyOutputArgs, opts ...InvokeOption) LookupCollectorPolicyResultOutput
Copy

> Note: This function is named LookupCollectorPolicy in the Go SDK.

public static class GetCollectorPolicy 
{
    public static Task<GetCollectorPolicyResult> InvokeAsync(GetCollectorPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetCollectorPolicyResult> Invoke(GetCollectorPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCollectorPolicyResult> getCollectorPolicy(GetCollectorPolicyArgs args, InvokeOptions options)
public static Output<GetCollectorPolicyResult> getCollectorPolicy(GetCollectorPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:networkfunction:getCollectorPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AzureTrafficCollectorName
This property is required.
Changes to this property will trigger replacement.
string
Azure Traffic Collector name
CollectorPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Collector Policy Name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AzureTrafficCollectorName
This property is required.
Changes to this property will trigger replacement.
string
Azure Traffic Collector name
CollectorPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Collector Policy Name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
azureTrafficCollectorName
This property is required.
Changes to this property will trigger replacement.
String
Azure Traffic Collector name
collectorPolicyName
This property is required.
Changes to this property will trigger replacement.
String
Collector Policy Name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
azureTrafficCollectorName
This property is required.
Changes to this property will trigger replacement.
string
Azure Traffic Collector name
collectorPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Collector Policy Name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
azure_traffic_collector_name
This property is required.
Changes to this property will trigger replacement.
str
Azure Traffic Collector name
collector_policy_name
This property is required.
Changes to this property will trigger replacement.
str
Collector Policy Name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
azureTrafficCollectorName
This property is required.
Changes to this property will trigger replacement.
String
Azure Traffic Collector name
collectorPolicyName
This property is required.
Changes to this property will trigger replacement.
String
Collector Policy Name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getCollectorPolicy Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state.
SystemData Pulumi.AzureNative.NetworkFunction.Outputs.TrackedResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type.
EmissionPolicies List<Pulumi.AzureNative.NetworkFunction.Outputs.EmissionPoliciesPropertiesFormatResponse>
Emission policies.
IngestionPolicy Pulumi.AzureNative.NetworkFunction.Outputs.IngestionPolicyPropertiesFormatResponse
Ingestion policies.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state.
SystemData TrackedResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type.
EmissionPolicies []EmissionPoliciesPropertiesFormatResponse
Emission policies.
IngestionPolicy IngestionPolicyPropertiesFormatResponse
Ingestion policies.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state.
systemData TrackedResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
type String
Resource type.
emissionPolicies List<EmissionPoliciesPropertiesFormatResponse>
Emission policies.
ingestionPolicy IngestionPolicyPropertiesFormatResponse
Ingestion policies.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Resource ID.
location string
Resource location.
name string
Resource name.
provisioningState string
The provisioning state.
systemData TrackedResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
type string
Resource type.
emissionPolicies EmissionPoliciesPropertiesFormatResponse[]
Emission policies.
ingestionPolicy IngestionPolicyPropertiesFormatResponse
Ingestion policies.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Resource ID.
location str
Resource location.
name str
Resource name.
provisioning_state str
The provisioning state.
system_data TrackedResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
type str
Resource type.
emission_policies Sequence[EmissionPoliciesPropertiesFormatResponse]
Emission policies.
ingestion_policy IngestionPolicyPropertiesFormatResponse
Ingestion policies.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Resource type.
emissionPolicies List<Property Map>
Emission policies.
ingestionPolicy Property Map
Ingestion policies.
tags Map<String>
Resource tags.

Supporting Types

EmissionPoliciesPropertiesFormatResponse

EmissionDestinations []EmissionPolicyDestinationResponse
Emission policy destinations.
EmissionType string
Emission format type.
emissionDestinations List<EmissionPolicyDestinationResponse>
Emission policy destinations.
emissionType String
Emission format type.
emissionDestinations EmissionPolicyDestinationResponse[]
Emission policy destinations.
emissionType string
Emission format type.
emission_destinations Sequence[EmissionPolicyDestinationResponse]
Emission policy destinations.
emission_type str
Emission format type.
emissionDestinations List<Property Map>
Emission policy destinations.
emissionType String
Emission format type.

EmissionPolicyDestinationResponse

DestinationType string
Emission destination type.
DestinationType string
Emission destination type.
destinationType String
Emission destination type.
destinationType string
Emission destination type.
destination_type str
Emission destination type.
destinationType String
Emission destination type.

IngestionPolicyPropertiesFormatResponse

ingestionSources List<Property Map>
Ingestion Sources.
ingestionType String
The ingestion type.

IngestionSourcesPropertiesFormatResponse

ResourceId string
Resource ID.
SourceType string
Ingestion source type.
ResourceId string
Resource ID.
SourceType string
Ingestion source type.
resourceId String
Resource ID.
sourceType String
Ingestion source type.
resourceId string
Resource ID.
sourceType string
Ingestion source type.
resource_id str
Resource ID.
source_type str
Ingestion source type.
resourceId String
Resource ID.
sourceType String
Ingestion source type.

TrackedResourceResponseSystemData

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native