Diagnostic Settings - Create Or Update

指定したリソースの診断設定を作成または更新します。

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

URI パラメーター

名前 / 必須 説明
name
path True

string

診断設定の名前。

resourceUri
path True

string

リソースの識別子。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
properties.eventHubAuthorizationRuleId

string

イベント ハブ承認規則のリソース ID。

properties.eventHubName

string

イベント ハブの名前。 何も指定しない場合は、既定のイベント ハブが選択されます。

properties.logAnalyticsDestinationType

string

Log Analytics へのエクスポートで既定の宛先の種類 (AzureDiagnostics など) を使用するか、または次のように構築された宛先の型を使用するかを示す文字列: _。 使用可能な値は、Dedicated と null です (null は既定値です)。

properties.logs

LogSettings[]

ログ設定の一覧。

properties.marketplacePartnerId

string

診断ログを送信する Marketplace リソースの完全な ARM リソース ID。

properties.metrics

MetricSettings[]

メトリック設定の一覧。

properties.serviceBusRuleId

string

診断設定の Service Bus ルール ID。 これは、下位互換性を維持するためにここにあります。

properties.storageAccountId

string

診断ログを送信するストレージ アカウントのリソース ID。

properties.workspaceId

string

診断ログを送信する Log Analytics ワークスペースの完全な ARM リソース ID。 例: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

応答

名前 説明
200 OK

DiagnosticSettingsResource

診断設定を作成するための要求が成功しました

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

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

Creates or Updates the diagnostic setting

要求のサンプル

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"
  }
}

応答のサンプル

{
  "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

要求のサンプル

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"
  }
}

応答のサンプル

{
  "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"
  }
}

定義

名前 説明
createdByType

リソースを作成した ID の種類。

DiagnosticSettingsResource

診断設定リソース。

ErrorResponse

エラー応答の形式について説明します。

LogSettings

MultiTenantDiagnosticSettings の一部。 特定のログの設定を指定します。

MetricSettings

MultiTenantDiagnosticSettings の一部。 特定のメトリックの設定を指定します。

RetentionPolicy

ログの保持ポリシーを指定します。

systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

診断設定リソース。

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties.eventHubAuthorizationRuleId

string

イベント ハブ承認規則のリソース ID。

properties.eventHubName

string

イベント ハブの名前。 何も指定しない場合は、既定のイベント ハブが選択されます。

properties.logAnalyticsDestinationType

string

Log Analytics へのエクスポートで既定の宛先の種類 (AzureDiagnostics など) を使用するか、または次のように構築された宛先の型を使用するかを示す文字列: _。 使用可能な値は、Dedicated と null です (null は既定値です)。

properties.logs

LogSettings[]

ログ設定の一覧。

properties.marketplacePartnerId

string

診断ログを送信する Marketplace リソースの完全な ARM リソース ID。

properties.metrics

MetricSettings[]

メトリック設定の一覧。

properties.serviceBusRuleId

string

診断設定の Service Bus ルール ID。 これは、下位互換性を維持するためにここにあります。

properties.storageAccountId

string

診断ログを送信するストレージ アカウントのリソース ID。

properties.workspaceId

string

診断ログを送信する Log Analytics ワークスペースの完全な ARM リソース ID。 例: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

systemData

systemData

このリソースに関連するシステム メタデータ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ErrorResponse

エラー応答の形式について説明します。

名前 説明
code

string

エラー コード

message

string

操作が失敗した理由を示すエラー メッセージ。

LogSettings

MultiTenantDiagnosticSettings の一部。 特定のログの設定を指定します。

名前 説明
category

string

この設定が適用されるリソースの種類の診断ログ カテゴリの名前。 リソースの診断ログ カテゴリの一覧を取得するには、まず診断設定の取得操作を実行します。

categoryGroup

string

この設定が適用されるリソースの種類の診断ログ カテゴリ グループの名前。 リソースの診断ログ カテゴリの一覧を取得するには、まず診断設定の取得操作を実行します。

enabled

boolean

このログが有効かどうかを示す値。

retentionPolicy

RetentionPolicy

このログのアイテム保持ポリシー。

MetricSettings

MultiTenantDiagnosticSettings の一部。 特定のメトリックの設定を指定します。

名前 説明
category

string

この設定が適用されるリソースの種類の診断メトリック カテゴリの名前。 リソースの診断メトリック カテゴリの一覧を取得するには、まず GET 診断設定操作を実行します。

enabled

boolean

このカテゴリが有効かどうかを示す値。

retentionPolicy

RetentionPolicy

このカテゴリのアイテム保持ポリシー。

timeGrain

string

メトリックのタイムグレインをISO8601形式で指定します。

RetentionPolicy

ログの保持ポリシーを指定します。

名前 説明
days

integer

リテンション期間の日数を日数で指定します。 値が 0 の場合、イベントは無期限に保持されます。

enabled

boolean

アイテム保持ポリシーが有効かどうかを示す値。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。