次の方法で共有


Set-AzDiagnosticSetting

リソースのログとメトリックの設定を設定します。

構文

Set-AzDiagnosticSetting
   -ResourceId <String>
   [-Name <String>]
   [-StorageAccountId <String>]
   [-ServiceBusRuleId <String>]
   [-EventHubName <String>]
   [-EventHubAuthorizationRuleId <String>]
   [-Enabled <Boolean>]
   [-Category <System.Collections.Generic.List`1[System.String]>]
   [-MetricCategory <System.Collections.Generic.List`1[System.String]>]
   [-Timegrain <System.Collections.Generic.List`1[System.String]>]
   [-RetentionEnabled <Boolean>]
   [-WorkspaceId <String>]
   [-ExportToResourceSpecific]
   [-RetentionInDays <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDiagnosticSetting
   -InputObject <PSServiceDiagnosticSettings>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzDiagnosticSetting コマンドレットは、特定のリソースの各タイム グレインとログ カテゴリを有効または無効にします。 ログとメトリックは、指定されたストレージ アカウントに格納されます。 このコマンドレットは ShouldProcess パターンを実装します。つまり、リソースを実際に作成、変更、または削除する前に、ユーザーに確認を要求する場合があります。

例 1: リソースのすべてのメトリックとログを有効にする

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True

このコマンドを実行すると、Resource01 で使用可能なすべてのメトリックとログが有効になります。

例 2: すべてのメトリックとログを無効にする

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False

このコマンドは、リソース Resource01 で使用可能なすべてのメトリックとログを無効にします。

例 3: 複数のメトリック カテゴリを有効または無効にする

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False -MetricCategory MetricCategory1,MetricCategory2
StorageAccountId   : <storageAccountId>
StorageAccountName : <storageAccountName>
Metrics
   Enabled   : False
   Category  : MetricCategory1
   Timegrain : PT1M
   Enabled   : False
   Category  : MetricCategory2
   Timegrain : PT1H
   Enabled   : True
   Category  : MetricCategory3
   Timegrain : PT1H
Logs
   Enabled  : True
   Category : Category1
   Enabled  : True
   Category : Category2
   Enabled  : True
   Category : Category3
   Enabled  : False
   Category : Category4

このコマンドは、Category1 と Category2 というメトリック カテゴリを無効にします。 その他のカテゴリはすべて同じままです。

例 4: 複数のログ カテゴリを有効または無効にする

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2
StorageAccountId   : <storageAccountId>
StorageAccountName : <storageAccountName>
Metrics
   Enabled   : False
   Category  : MetricCategory1
   Timegrain : PT1M
   Enabled   : False
   Category  : MetricCategory2
   Timegrain : PT1H
   Enabled   : True
   Category  : MetricCategory3
   Timegrain : PT1H
Logs
   Enabled  : True
   Category : Category1
   Enabled  : True
   Category : Category2
   Enabled  : True
   Category : Category3
   Enabled  : False
   Category : Category4

このコマンドを実行すると、Category1 と Category2 が有効になります。 その他のメトリックとログのカテゴリはすべて同じままです。

例 4: 時間グレインと複数のカテゴリを有効にする

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2 -Timegrain PT1M

このコマンドは、Category1、Category2、および Time Grain PT1M のみを有効にします。 その他すべてのタイム グレインとカテゴリは変更されません。

例 5: パイプラインの使用

PS C:\>Get-AzDiagnosticSetting -ResourceId "Resource01" | Set-AzDiagnosticSetting -Enabled $True -Category Category1,Category2

このコマンドでは、PowerShell パイプラインを使用して診断設定を設定 (変更なし) します。

パラメーター

-Category

Enabledの値に従って、有効または無効にするログ カテゴリの一覧を指定します。 カテゴリが指定されていない場合、このコマンドはサポートされているすべてのカテゴリで動作します。

型:List<T>[String]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Enabled

診断を有効にするかどうかを示します。 診断を有効にする$Trueを指定するか、診断を無効にする$Falseを指定します。

型:Boolean
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-EventHubAuthorizationRuleId

イベント ハブ承認規則 ID

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-EventHubName

イベント ハブ名

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ExportToResourceSpecific

defaultAzureDiagnostics という動的スキーマ テーブルとは対照的に、LA へのエクスポートをリソース固有のテーブル (専用または固定のスキーマ テーブル) に対して実行する必要があることを示すフラグ。

この引数は、引数 -workspaceId も指定されている場合にのみ有効です。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-InputObject

入力オブジェクト (パイプラインから可能)。このオブジェクトから name と resourceId が抽出されます。

型:PSServiceDiagnosticSettings
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-MetricCategory

メトリック カテゴリの一覧。 カテゴリが指定されていない場合、このコマンドはサポートされているすべてのカテゴリで動作します。

型:List<T>[String]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

診断設定の名前。 既定値は service です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceId

リソースの ID を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RetentionEnabled

診断情報の保持が有効かどうかを示します。

型:Nullable<T>[Boolean]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RetentionInDays

アイテム保持ポリシーを日数で指定します。

型:Nullable<T>[Int32]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ServiceBusRuleId

Service Bus ルール ID。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-StorageAccountId

データを保存するストレージ アカウントの ID を指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Timegrain

Enabledの値に従って、メトリックに対して有効または無効にする時間グレインを指定します。 時間グレインを指定しない場合、このコマンドは使用可能なすべての時間グレインで動作します。

型:List<T>[String]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WorkspaceId

ログ/メトリックを送信する Log Analytics ワークスペースのリソース ID

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

PSServiceDiagnosticSettings

String

Boolean

List<T>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

出力

PSServiceDiagnosticSettings