Diagnostic Settings - Create Or Update

  • Referensi
Service:
Monitor
API Version:
2021-05-01-preview

Membuat atau memperbarui pengaturan diagnostik untuk sumber daya yang ditentukan.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview

Parameter URI

Name In Required Type Description
name
 path True
  • string

Nama pengaturan diagnostik.
resourceUri
 path True
  • string

Pengidentifikasi sumber daya.
api-version
 query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Type Description
properties.eventHubAuthorizationRuleId
  • string

Id sumber daya untuk aturan otorisasi pusat aktivitas.
properties.eventHubName
  • string

Nama event hub. Jika tidak ada yang ditentukan, hub peristiwa default akan dipilih.
properties.logAnalyticsDestinationType
  • string

String yang menunjukkan apakah ekspor ke Analitik Log harus menggunakan jenis tujuan default, yaitu AzureDiagnostics, atau menggunakan jenis tujuan yang dibangun sebagai berikut: _. Nilai yang mungkin adalah: Khusus dan null (null adalah default.)
properties.logs

Daftar pengaturan log.
properties.marketplacePartnerId
  • string

ID sumber daya ARM lengkap dari sumber daya Marketplace tempat Anda ingin mengirim Log Diagnostik.
properties.metrics

Daftar pengaturan metrik.
properties.serviceBusRuleId
  • string

Id aturan bus layanan dari pengaturan diagnostik. Ini di sini untuk menjaga kompatibilitas mundur.
properties.storageAccountId
  • string

ID sumber daya akun penyimpanan tempat Anda ingin mengirim Log Diagnostik.
properties.workspaceId
  • string

ID sumber daya ARM lengkap dari ruang kerja Analitik Log tempat Anda ingin mengirim Log Diagnostik. Contoh: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Respons

Name Type Description
200 OK

Permintaan berhasil untuk membuat pengaturan diagnostik
Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

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

Creates or Updates the diagnostic setting
Creates or Updates the diagnostic setting for category

Creates or Updates the diagnostic setting

Sample Request

PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

{
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting",
  "type": "Microsoft.Insights/diagnosticSettings",
  "name": "mysetting",
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Creates or Updates the diagnostic setting for category

Sample Request

PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

{
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "category": "WorkflowRuntime",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
  "type": "",
  "name": "mysetting",
  "properties": {
    "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "",
    "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "eventHubName": "myeventhub",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "metrics": [
      {
        "category": "WorkflowMetrics",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logs": [
      {
        "category": "WorkflowRuntime",
        "enabled": true,
        "retentionPolicy": {
          "enabled": false,
          "days": 0
        }
      }
    ],
    "logAnalyticsDestinationType": "Dedicated"
  }
}

Definisi

createdByType

Jenis identitas yang membuat sumber daya.
DiagnosticSettingsResource

Sumber daya pengaturan diagnostik.
ErrorResponse

Menjelaskan format respons Kesalahan.
LogSettings

Bagian dari MultiTenantDiagnosticSettings. Menentukan pengaturan untuk log tertentu.
MetricSettings

Bagian dari MultiTenantDiagnosticSettings. Menentukan pengaturan untuk metrik tertentu.
RetentionPolicy

Menentukan kebijakan penyimpanan untuk log.
systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

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

DiagnosticSettingsResource

Sumber daya pengaturan diagnostik.

Name Type Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name
  • string

Nama sumber daya.
properties.eventHubAuthorizationRuleId
  • string

Id sumber daya untuk aturan otorisasi pusat aktivitas.
properties.eventHubName
  • string

Nama event hub. Jika tidak ada yang ditentukan, hub peristiwa default akan dipilih.
properties.logAnalyticsDestinationType
  • string

String yang menunjukkan apakah ekspor ke Analitik Log harus menggunakan jenis tujuan default, yaitu AzureDiagnostics, atau menggunakan jenis tujuan yang dibangun sebagai berikut: _. Nilai yang mungkin adalah: Khusus dan null (null adalah default.)
properties.logs

Daftar pengaturan log.
properties.marketplacePartnerId
  • string

ID sumber daya ARM lengkap dari sumber daya Marketplace tempat Anda ingin mengirim Log Diagnostik.
properties.metrics

Daftar pengaturan metrik.
properties.serviceBusRuleId
  • string

Id aturan bus layanan dari pengaturan diagnostik. Ini di sini untuk menjaga kompatibilitas mundur.
properties.storageAccountId
  • string

ID sumber daya akun penyimpanan tempat Anda ingin mengirim Log Diagnostik.
properties.workspaceId
  • string

ID sumber daya ARM lengkap dari ruang kerja Analitik Log tempat Anda ingin mengirim Log Diagnostik. Contoh: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData

Metadata sistem yang terkait dengan sumber daya ini.
type
  • string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

ErrorResponse

Menjelaskan format respons Kesalahan.

Name Type Description
code
  • string

Kode kesalahan
message
  • string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

LogSettings

Bagian dari MultiTenantDiagnosticSettings. Menentukan pengaturan untuk log tertentu.

Name Type Description
category
  • string

Nama kategori Log Diagnostik untuk jenis sumber daya tempat pengaturan ini diterapkan. Untuk mendapatkan daftar kategori Log Diagnostik untuk sumber daya, pertama-tama lakukan operasi pengaturan diagnostik GET.
categoryGroup
  • string

Nama grup kategori Log Diagnostik untuk jenis sumber daya tempat pengaturan ini diterapkan. Untuk mendapatkan daftar kategori Log Diagnostik untuk sumber daya, pertama-tama lakukan operasi pengaturan diagnostik GET.
enabled
  • boolean

nilai yang menunjukkan apakah log ini diaktifkan.
retentionPolicy

kebijakan penyimpanan untuk log ini.

MetricSettings

Bagian dari MultiTenantDiagnosticSettings. Menentukan pengaturan untuk metrik tertentu.

Name Type Description
category
  • string

Nama kategori Metrik Diagnostik untuk jenis sumber daya tempat pengaturan ini diterapkan. Untuk mendapatkan daftar kategori metrik Diagnostik untuk sumber daya, pertama-tama lakukan operasi pengaturan diagnostik GET.
enabled
  • boolean

nilai yang menunjukkan apakah kategori ini diaktifkan.
retentionPolicy

kebijakan penyimpanan untuk kategori ini.
timeGrain
  • string

timegrain metrik dalam format ISO8601.

RetentionPolicy

Menentukan kebijakan penyimpanan untuk log.

Name Type Description
days
  • integer

jumlah hari untuk retensi dalam hari. Nilai 0 akan mempertahankan peristiwa tanpa batas waktu.
enabled
  • boolean

nilai yang menunjukkan apakah kebijakan penyimpanan diaktifkan.

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 memodifikasi sumber daya.
lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.