Edit

Share via

Update-AzDataCollectionRule

  • Reference
Module:
Az.Monitor

Update a data collection rule.

Syntax

Update-AzDataCollectionRule
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DataCollectionEndpointId <String>]
      [-DataFlow <IDataFlow[]>]
      [-DataSourceDataImportEventHubConsumerGroup <String>]
      [-DataSourceDataImportEventHubName <String>]
      [-DataSourceDataImportEventHubStream <String>]
      [-DataSourceExtension <IExtensionDataSource[]>]
      [-DataSourceIisLog <IIisLogsDataSource[]>]
      [-DataSourceLogFile <ILogFilesDataSource[]>]
      [-DataSourcePerformanceCounter <IPerfCounterDataSource[]>]
      [-DataSourcePlatformTelemetry <IPlatformTelemetryDataSource[]>]
      [-DataSourcePrometheusForwarder <IPrometheusForwarderDataSource[]>]
      [-DataSourceSyslog <ISyslogDataSource[]>]
      [-DataSourceWindowsEventLog <IWindowsEventLogDataSource[]>]
      [-DataSourceWindowsFirewallLog <IWindowsFirewallLogsDataSource[]>]
      [-Description <String>]
      [-DestinationAzureMonitorMetricName <String>]
      [-DestinationEventHub <IEventHubDestination[]>]
      [-DestinationEventHubsDirect <IEventHubDirectDestination[]>]
      [-DestinationLogAnalytic <ILogAnalyticsDestination[]>]
      [-DestinationMonitoringAccount <IMonitoringAccountDestination[]>]
      [-DestinationStorageAccount <IStorageBlobDestination[]>]
      [-DestinationStorageBlobsDirect <IStorageBlobDestination[]>]
      [-DestinationStorageTablesDirect <IStorageTableDestination[]>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-Kind <String>]
      [-StreamDeclaration <Hashtable>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzDataCollectionRule
      -InputObject <IDataCollectionRuleIdentity>
      [-DataCollectionEndpointId <String>]
      [-DataFlow <IDataFlow[]>]
      [-DataSourceDataImportEventHubConsumerGroup <String>]
      [-DataSourceDataImportEventHubName <String>]
      [-DataSourceDataImportEventHubStream <String>]
      [-DataSourceExtension <IExtensionDataSource[]>]
      [-DataSourceIisLog <IIisLogsDataSource[]>]
      [-DataSourceLogFile <ILogFilesDataSource[]>]
      [-DataSourcePerformanceCounter <IPerfCounterDataSource[]>]
      [-DataSourcePlatformTelemetry <IPlatformTelemetryDataSource[]>]
      [-DataSourcePrometheusForwarder <IPrometheusForwarderDataSource[]>]
      [-DataSourceSyslog <ISyslogDataSource[]>]
      [-DataSourceWindowsEventLog <IWindowsEventLogDataSource[]>]
      [-DataSourceWindowsFirewallLog <IWindowsFirewallLogsDataSource[]>]
      [-Description <String>]
      [-DestinationAzureMonitorMetricName <String>]
      [-DestinationEventHub <IEventHubDestination[]>]
      [-DestinationEventHubsDirect <IEventHubDirectDestination[]>]
      [-DestinationLogAnalytic <ILogAnalyticsDestination[]>]
      [-DestinationMonitoringAccount <IMonitoringAccountDestination[]>]
      [-DestinationStorageAccount <IStorageBlobDestination[]>]
      [-DestinationStorageBlobsDirect <IStorageBlobDestination[]>]
      [-DestinationStorageTablesDirect <IStorageTableDestination[]>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-Kind <String>]
      [-StreamDeclaration <Hashtable>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update a data collection rule.

Examples

Example 1: Update tag for data collection rule

$syslog = New-AzSyslogDataSourceObject -FacilityName syslog -LogLevel Alert,Critical,Emergency -Name syslogBase -Stream Microsoft-Syslog
Update-AzDataCollectionRule -Name myCollectionRule1 -ResourceGroupName Monitor-ActionGroup -DataSourceSyslog $syslog

DataCollectionEndpointId                  : 
DataFlow                                  : {{
                                              "streams": [ "Microsoft-InsightsMetrics" ],
                                              "destinations": [ "azureMonitorMetrics-default" ]
                                            }}
DataSourceDataImportEventHubConsumerGroup : 
DataSourceDataImportEventHubName          : 
DataSourceDataImportEventHubStream        : 
DataSourceExtension                       : 
DataSourceIisLog                          : 
DataSourceLogFile                         : 
DataSourcePerformanceCounter              : {{
                                              "streams": [ "Microsoft-Perf" ],
                                              "samplingFrequencyInSeconds": 15,
                                              "counterSpecifiers": [ "\\\\Processor(_Total)\\\\% Processor Time", "\\\\Memory\\\\Committed Bytes",
                                            "\\\\LogicalDisk(_Total)\\\\Free Megabytes", "\\\\PhysicalDisk(_Total)\\\\Avg. Disk Queue Length" ],
                                              "name": "cloudTeamCoreCounters"
                                            }, {
                                              "streams": [ "Microsoft-Perf" ],
                                              "samplingFrequencyInSeconds": 30,
                                              "counterSpecifiers": [ "\\\\Process(_Total)\\\\Thread Count" ],
                                              "name": "appTeamExtraCounters"
                                            }}
DataSourcePlatformTelemetry               : 
DataSourcePrometheusForwarder             : 
DataSourceSyslog                          : {{
                                              "streams": [ "Microsoft-Syslog" ],
                                              "facilityNames": [ "syslog" ],
                                              "logLevels": [ "Alert", "Critical", "Emergency" ],
                                              "name": "syslogBase"
                                            }}
DataSourceWindowsEventLog                 : {{
                                              "streams": [ "Microsoft-WindowsEvent" ],
                                              "xPathQueries": [ "System![System[(Level = 1 or Level = 2 or Level = 3)]]", "Application!*[System[(Level = 1 or Level = 2   
                                            or Level = 3)]]" ],
                                              "name": "appTeam1AppEvents"
                                            }}
DataSourceWindowsFirewallLog              : 
Description                               : 
DestinationAzureMonitorMetricName         : azureMonitorMetrics-default
DestinationEventHub                       : 
DestinationEventHubsDirect                : 
DestinationLogAnalytic                    : 
DestinationMonitoringAccount              : 
DestinationStorageAccount                 : 
DestinationStorageBlobsDirect             : 
DestinationStorageTablesDirect            : 
Etag                                      : "9200a3d3-0000-0100-0000-654c72ae0000"
Id                                        : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Monitor-ActionGroup/providers/Microsoft.Insights/dataColle 
                                            ctionRules/myCollectionRule1
IdentityPrincipalId                       : 
IdentityTenantId                          : 
IdentityType                              : 
IdentityUserAssignedIdentity              : {
                                            }
ImmutableId                               : dcr-e30a8188813f426d962ef7053a3d1be4
Kind                                      : 
Location                                  : eastus
MetadataProvisionedBy                     : 
MetadataProvisionedByResourceId           : 
Name                                      : myCollectionRule1
ProvisioningState                         : Succeeded
ResourceGroupName                         : Monitor-ActionGroup
StreamDeclaration                         : {
                                            }
SystemDataCreatedAt                       : 11/9/2023 5:04:01 AM
SystemDataCreatedBy                       : v-jiaji@microsoft.com
SystemDataCreatedByType                   : User
SystemDataLastModifiedAt                  : 11/9/2023 5:48:29 AM
SystemDataLastModifiedBy                  : v-jiaji@microsoft.com
SystemDataLastModifiedByType              : User
Tag                                       : {
                                            }
Type                                      : Microsoft.Insights/dataCollectionRules

This command updates data collection rule.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DataCollectionEndpointId

The resource ID of the data collection endpoint that this rule can be used with.

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

-DataFlow

The specification of data flows.

Type:IDataFlow[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourceDataImportEventHubConsumerGroup

Event Hub consumer group name

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

-DataSourceDataImportEventHubName

A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.

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

-DataSourceDataImportEventHubStream

The stream to collect from EventHub

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

-DataSourceExtension

The list of Azure VM extension data source configurations.

Type:IExtensionDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourceIisLog

The list of IIS logs source configurations.

Type:IIisLogsDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourceLogFile

The list of Log files source configurations.

Type:ILogFilesDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourcePerformanceCounter

The list of performance counter data source configurations.

Type:IPerfCounterDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourcePlatformTelemetry

The list of platform telemetry configurations

Type:IPlatformTelemetryDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourcePrometheusForwarder

The list of Prometheus forwarder data source configurations.

Type:IPrometheusForwarderDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourceSyslog

The list of Syslog data source configurations.

Type:ISyslogDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourceWindowsEventLog

The list of Windows Event Log data source configurations.

Type:IWindowsEventLogDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataSourceWindowsFirewallLog

The list of Windows Firewall logs source configurations.

Type:IWindowsFirewallLogsDataSource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Description of the data collection rule.

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

-DestinationAzureMonitorMetricName

A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule.

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

-DestinationEventHub

List of Event Hubs destinations.

Type:IEventHubDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationEventHubsDirect

List of Event Hubs Direct destinations.

Type:IEventHubDirectDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationLogAnalytic

List of Log Analytics destinations.

Type:ILogAnalyticsDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationMonitoringAccount

List of monitoring account destinations.

Type:IMonitoringAccountDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationStorageAccount

List of storage accounts destinations.

Type:IStorageBlobDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationStorageBlobsDirect

List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent.

Type:IStorageBlobDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationStorageTablesDirect

List of Storage Table Direct destinations.

Type:IStorageTableDestination[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableSystemAssignedIdentity

Determines whether to enable a system-assigned identity for the resource.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

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

-Kind

The kind of the resource.

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

-Name

The name of the data collection rule. The name is case insensitive.

Type:String
Aliases:DataCollectionRuleName, RuleName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-StreamDeclaration

Declaration of custom streams used in this rule.

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

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

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

-UserAssignedIdentity

The array of user assigned identities associated with the resource. The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'

Type:String[]
Position:Named
Default value:None
Required:False
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IDataCollectionRuleIdentity

Outputs

IDataCollectionRuleResource