Data Collection Rules - Create

Membuat atau memperbarui aturan pengumpulan data.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}?api-version=2021-04-01

Parameter URI

Name In Required Type Description
dataCollectionRuleName
path True
  • string

Nama aturan pengumpulan data. Nama tidak peka huruf besar/kecil.

resourceGroupName
path True
  • string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

subscriptionId
path True
  • string

ID langganan target.

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Required Type Description
location True
  • string

Lokasi geografis tempat sumber daya berada.

kind

Jenis sumber daya.

properties.dataFlows

Spesifikasi aliran data.

properties.dataSources

Spesifikasi sumber data. Properti ini bersifat opsional dan dapat dihilangkan jika aturan dimaksudkan untuk digunakan melalui panggilan langsung ke titik akhir yang disediakan.

properties.description
  • string

Deskripsi aturan pengumpulan data.

properties.destinations

Spesifikasi tujuan.

tags
  • object

Tag sumber daya.

Respons

Name Type Description
200 OK

Aturan pengumpulan data berhasil diperbarui

201 Created

Aturan pengumpulan data berhasil dibuat

Other Status Codes

Kesalahan

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

Create or update data collection rule

Sample Request

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}
{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Definisi

AzureMonitorMetrics

Tujuan Metrik Azure Monitor.

createdByType

Jenis identitas yang membuat sumber daya.

DataCollectionRuleResource

Definisi sumber daya tingkat atas yang dilacak ARM.

DataFlow

Definisi aliran mana yang dikirim ke tujuan mana.

DataSources

Spesifikasi sumber data. Properti ini bersifat opsional dan dapat dihilangkan jika aturan dimaksudkan untuk digunakan melalui panggilan langsung ke titik akhir yang disediakan.

Destinations

Spesifikasi tujuan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponseCommonV2

Respons kesalahan

ExtensionDataSource

Definisi data mana yang akan dikumpulkan dari ekstensi VM terpisah yang terintegrasi dengan Agen Azure Monitor. Dikumpulkan dari komputer Windows dan Linux, tergantung pada ekstensi mana yang ditentukan.

KnownDataCollectionRuleProvisioningState

Status penyediaan sumber daya.

KnownDataCollectionRuleResourceKind

Jenis sumber daya.

LogAnalyticsDestination

Tujuan Analitik Log.

PerfCounterDataSource

Definisi penghitung kinerja mana yang akan dikumpulkan dan bagaimana penghitung tersebut akan dikumpulkan oleh aturan pengumpulan data ini. Dikumpulkan dari mesin Windows dan Linux tempat penghitung hadir.

SyslogDataSource

Definisi data syslog mana yang akan dikumpulkan dan bagaimana data tersebut akan dikumpulkan. Hanya dikumpulkan dari komputer Linux.

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

WindowsEventLogDataSource

Definisi peristiwa Log Peristiwa Windows mana yang akan dikumpulkan dan bagaimana peristiwa tersebut akan dikumpulkan. Hanya dikumpulkan dari mesin Windows.

AzureMonitorMetrics

Tujuan Metrik Azure Monitor.

Name Type Description
name
  • string

Nama yang mudah diingat untuk tujuan. Nama ini harus unik di semua tujuan (terlepas dari jenisnya) dalam aturan pengumpulan data.

createdByType

Jenis identitas yang membuat sumber daya.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataCollectionRuleResource

Definisi sumber daya tingkat atas yang dilacak ARM.

Name Type Description
etag
  • string

Tag entitas sumber daya (ETag).

id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat.

kind

Jenis sumber daya.

location
  • string

Lokasi geografis tempat sumber daya berada.

name
  • string

Nama sumber daya.

properties.dataFlows

Spesifikasi aliran data.

properties.dataSources

Spesifikasi sumber data. Properti ini bersifat opsional dan dapat dihilangkan jika aturan dimaksudkan untuk digunakan melalui panggilan langsung ke titik akhir yang disediakan.

properties.description
  • string

Deskripsi aturan pengumpulan data.

properties.destinations

Spesifikasi tujuan.

properties.immutableId
  • string

ID yang tidak dapat diubah dari aturan pengumpulan data ini. Properti ini BERSIFAT BACA-SAJA.

properties.provisioningState

Status penyediaan sumber daya.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

tags
  • object

Tag sumber daya.

type
  • string

Jenis sumber daya.

DataFlow

Definisi aliran mana yang dikirim ke tujuan mana.

Name Type Description
destinations
  • string[]

Daftar tujuan untuk aliran data ini.

streams
  • string[]

Daftar aliran untuk aliran data ini.

DataSources

Spesifikasi sumber data. Properti ini bersifat opsional dan dapat dihilangkan jika aturan dimaksudkan untuk digunakan melalui panggilan langsung ke titik akhir yang disediakan.

Name Type Description
extensions

Daftar konfigurasi sumber data ekstensi Azure VM.

performanceCounters

Daftar konfigurasi sumber data penghitung kinerja.

syslog

Daftar konfigurasi sumber data Syslog.

windowsEventLogs

Daftar konfigurasi sumber data Log Peristiwa Windows.

Destinations

Spesifikasi tujuan.

Name Type Description
azureMonitorMetrics

Tujuan Metrik Azure Monitor.

logAnalytics

Daftar tujuan Analitik Log.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Name Type Description
info
  • object

Info tambahan.

type
  • string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Name Type Description
additionalInfo

Info tambahan kesalahan.

code
  • string

Kode kesalahan.

details

Detail kesalahan.

message
  • string

Pesan kesalahan.

target
  • string

Target kesalahan.

ErrorResponseCommonV2

Respons kesalahan

Name Type Description
error

Objek kesalahan.

ExtensionDataSource

Definisi data mana yang akan dikumpulkan dari ekstensi VM terpisah yang terintegrasi dengan Agen Azure Monitor. Dikumpulkan dari komputer Windows dan Linux, tergantung pada ekstensi mana yang ditentukan.

Name Type Description
extensionName
  • string

Nama ekstensi VM.

extensionSettings
  • object

Pengaturan ekstensi. Format ini khusus untuk ekstensi tertentu.

inputDataSources
  • string[]

Daftar sumber data tempat ekstensi ini membutuhkan data.

name
  • string

Nama yang mudah diingat untuk sumber data. Nama ini harus unik di semua sumber data (terlepas dari jenisnya) dalam aturan pengumpulan data.

streams
  • string[]

Daftar aliran tempat sumber data ini akan dikirim. Aliran menunjukkan skema apa yang akan digunakan untuk data ini dan biasanya tabel apa di Analitik Log tempat data akan dikirim.

KnownDataCollectionRuleProvisioningState

Status penyediaan sumber daya.

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

KnownDataCollectionRuleResourceKind

Jenis sumber daya.

Name Type Description
Linux
  • string
Windows
  • string

LogAnalyticsDestination

Tujuan Analitik Log.

Name Type Description
name
  • string

Nama yang mudah diingat untuk tujuan. Nama ini harus unik di semua tujuan (terlepas dari jenisnya) dalam aturan pengumpulan data.

workspaceId
  • string

ID Pelanggan dari ruang kerja Analitik Log.

workspaceResourceId
  • string

ID sumber daya ruang kerja Analitik Log.

PerfCounterDataSource

Definisi penghitung kinerja mana yang akan dikumpulkan dan bagaimana penghitung tersebut akan dikumpulkan oleh aturan pengumpulan data ini. Dikumpulkan dari mesin Windows dan Linux tempat penghitung hadir.

Name Type Description
counterSpecifiers
  • string[]

Daftar nama penentu penghitung kinerja yang ingin Anda kumpulkan. Gunakan kartubebas (*) untuk mengumpulkan penghitung untuk semua instans. Untuk mendapatkan daftar penghitung kinerja di Windows, jalankan perintah 'typeperf'.

name
  • string

Nama yang mudah diingat untuk sumber data. Nama ini harus unik di semua sumber data (terlepas dari jenisnya) dalam aturan pengumpulan data.

samplingFrequencyInSeconds
  • integer

Jumlah detik antara pengukuran penghitung berturut-turut (sampel).

streams
  • string[]

Daftar aliran tempat sumber data ini akan dikirim. Aliran menunjukkan skema apa yang akan digunakan untuk data ini dan biasanya tabel apa di Analitik Log tempat data akan dikirim.

SyslogDataSource

Definisi data syslog mana yang akan dikumpulkan dan bagaimana data tersebut akan dikumpulkan. Hanya dikumpulkan dari komputer Linux.

Name Type Description
facilityNames
  • string[]

Daftar nama fasilitas.

logLevels
  • string[]

Tingkat log yang akan dikumpulkan.

name
  • string

Nama yang mudah diingat untuk sumber data. Nama ini harus unik di semua sumber data (terlepas dari jenisnya) dalam aturan pengumpulan data.

streams
  • string[]

Daftar aliran tempat sumber data ini akan dikirim. Aliran menunjukkan skema apa yang akan digunakan untuk data ini dan biasanya tabel apa di Analitik Log tempat data akan dikirim.

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt
  • string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy
  • string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

WindowsEventLogDataSource

Definisi peristiwa Log Peristiwa Windows mana yang akan dikumpulkan dan bagaimana peristiwa tersebut akan dikumpulkan. Hanya dikumpulkan dari mesin Windows.

Name Type Description
name
  • string

Nama yang mudah diingat untuk sumber data. Nama ini harus unik di semua sumber data (terlepas dari jenisnya) dalam aturan pengumpulan data.

streams
  • string[]

Daftar aliran tempat sumber data ini akan dikirim. Aliran menunjukkan skema apa yang akan digunakan untuk data ini dan biasanya tabel apa di Analitik Log tempat data akan dikirim.

xPathQueries
  • string[]

Daftar kueri log peristiwa Windows dalam format XPATH.