New-AzDataCollectionRuleAssociation

Reference

Module:: Az.Monitor

Create data collection rule association.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzDataCollectionRuleAssociation
     -TargetResourceId <string>
     -AssociationName <string>
     -RuleId <string>
     [-Description <string>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]  
   [<CommonParameters>]

New-AzDataCollectionRuleAssociation
     -TargetResourceId <string>
     -AssociationName <string>
     -InputObject <PSDataCollectionRuleResource>
     [-Description <string>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]  
   [<CommonParameters>]

Description

The New-AzDataCollectionRuleAssociation cmdlet creates a data collection rules association (DCRA).

To apply a DCR to a virtual machine, you create an association for the virtual machine. A virtual machine may have an association to multiple DCRs, and a DCR may have multiple virtual machines associated to it. This allows you to define a set of DCRs, each matching a particular requirement, and apply them to only the virtual machines where they apply. Here is the "Configure data collection for the Azure Monitor agent" using DCRA article.

Examples

Example 1: Create data collection rule association

PS C:\>$dcr = Get-AzDataCollectionRule -ResourceGroupName $rg -RuleName $dcrName
PS C:\>$vmId = '/subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}'
PS C:\>New-AzDataCollectionRuleAssociation -TargetResourceId $vmId -AssociationName "dcrAssoc" -RuleId $dcr.Id

Description          :
DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}
ProvisioningState    :
Etag                 : "{etag}"
Id                   : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/dcrAssoc
Name                 : dcrAssoc
Type                 : Microsoft.Insights/dataCollectionRuleAssociations

This command creates a data collection rule association for given rule and target resource ID.

Example 2: Create data collection rule association from a DCR object

PS C:\>$dcr = Get-AzDataCollectionRule -ResourceGroupName $rg -RuleName $dcrName
PS C:\>$vmId = '/subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}'
PS C:\>$dcr | New-AzDataCollectionRuleAssociation -TargetResourceId $vmId -AssociationName "dcrAssocInput"

Description          :
DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}
ProvisioningState    :
Etag                 : "{etag}"
Id                   : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/dcrAssocInput
Name                 : dcrAssocInput
Type                 : Microsoft.Insights/dataCollectionRuleAssociations

This command creates a data collection rule association for given rule and target resource ID.

Parameters

-AssociationName

The resource name

Type:	String
Aliases:	Name
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

The resource description

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

PSDataCollectionRuleResource Object

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-RuleId

The data collection rule ID

Type:	String
Aliases:	DataCollectionRuleId
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-TargetResourceId

The resource ID to associate

Type:	String
Aliases:	ResourceUri
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSDataCollectionRuleAssociationProxyOnlyResource