Set-AzDataCollectionRule
更新 (完整取代) 資料收集規則。
Syntax
Set-AzDataCollectionRule
-Location <String>
-ResourceGroupName <String>
-RuleName <String>
-RuleFile <String>
[-Description <String>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzDataCollectionRule
-Location <String>
-RuleId <String>
-RuleFile <String>
[-Description <String>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzDataCollectionRule
-InputObject <PSDataCollectionRuleResource>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Set-AzDataCollectionRule Cmdlet 會取代現有的資料收集規則。
資料收集規則 (DCR) 會定義傳入 Azure 監視器的資料,並指定要傳送或儲存該資料的位置。 以下是完整的 DCR 概觀文章 。
若要使用 -RuleFile 參數,請建構包含三個屬性的 json 檔案:dataSources、destinations、dataFlows(請參閱範例 #1)。
您可以在這裡 找到架構詳細資料 。
也支援使用 Cmdlet ConvertTo-Json 序列化的 DCR 輸出(範例 #2)。
範例
範例 1:更新資料收集規則、來自 Rest API 的 JSON
Set-AzDataCollectionRule -Location 'East US 2 EUAP' `
-ResourceGroupName 'testdcr' `
-RuleName 'newDcr' `
-RuleFile 'C:\samples\dcr1.json' `
-Description 'Updated Description'
Description : Updated Description
DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources
Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations
DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow}
ProvisioningState : Succeeded
Etag : "{etag}"
Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr
Name : newDcr
Type : Microsoft.Insights/dataCollectionRules
Location : East US 2 EUAP
Tags : {[tag2, value2], [tag1, value1]}
# Note: Content of C:\samples\dcr1.json
{
"properties": {
"dataSources": {
"performanceCounters": [
{
"streams": [
"Microsoft-InsightsMetrics"
],
"scheduledTransferPeriod": "PT1M",
"samplingFrequencyInSeconds": 10,
"counterSpecifiers": [
"\\Processor Information(_Total)\\% Processor Time"
],
"name": "perfCounter01"
}
]
},
"destinations": {
"azureMonitorMetrics": {
"name": "azureMonitorMetrics-default"
}
},
"dataFlows": [
{
"streams": [
"Microsoft-InsightsMetrics"
],
"destinations": [
"azureMonitorMetrics-default"
]
}
]
}
}
此命令會取代目前訂用帳戶的現有資料收集規則。
範例 2:從 PSDataCollectionRuleResource 更新資料收集規則 JSON
Set-AzDataCollectionRule -Location 'East US 2 EUAP' `
-RuleId '/subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr' `
-RuleFile 'C:\samples\dcr2.json' `
-Description 'Updated Description'
Description : Updated Description
DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources
Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations
DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow}
ProvisioningState : Succeeded
Etag : "{etag}"
Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr
Name : newDcr
Type : Microsoft.Insights/dataCollectionRules
Location : East US 2 EUAP
Tags : {[tag2, value2], [tag1, value1]}
# Note: Content of C:\samples\dcr2.json
{
"DataSources": {
"PerformanceCounters": [
{
"Streams": [
"Microsoft-InsightsMetrics"
],
"ScheduledTransferPeriod": "PT1M",
"SamplingFrequencyInSeconds": 10,
"CounterSpecifiers": [
"\\Processor Information(_Total)\\% Processor Time"
],
"Name": "perfCounter01"
}
]
},
"Destinations": {
"AzureMonitorMetrics": {
"Name": "azureMonitorMetrics-default"
}
},
"DataFlows": [
{
"Streams": [
"Microsoft-InsightsMetrics"
],
"Destinations": [
"azureMonitorMetrics-default"
]
}
]
}
此命令會取代目前訂用帳戶的現有資料收集規則。
範例 3:從 物件更新資料收集規則
$dcr = Get-AzDataCollectionRule -ResourceGroupName "testdcr" -Name "newDcr"
$dcr.Description = 'This is a test'
$dcr | Set-AzDataCollectionRule
Description : This is a test
DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources
Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations
DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow}
ProvisioningState : {provState}
Etag : "{etag}"
Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr
Name : newDcr
Type : Microsoft.Insights/dataCollectionRules
Location : East US 2 EUAP
Tags : {[tag2, value2], [tag1, value1]}
從 物件更新資料收集規則
參數
-Confirm
執行 Cmdlet 之前先提示您確認。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租使用者和訂用帳戶
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
資源描述
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
PSDataCollectionRuleResource 物件
Type: | PSDataCollectionRuleResource |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Location
資源位置
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
資源組名
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RuleFile
JSON 檔案路徑
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RuleId
資源識別碼
Type: | String |
Aliases: | ResourceId |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RuleName
資源名稱
Type: | String |
Aliases: | Name |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
資源標籤
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |