Log Analytics ワークスペース内のデータ保持を管理する

Log Analytics ワークスペース内の Analytics テーブルの既定の対話型保持期間を設定するには:

1. Azure portal の [Log Analytics ワークスペース] メニューからワークスペースを選択します。

2. 左側のウィンドウから [使用量と推定コスト] を選択します。

3. ページの上部にある [データ保持] を選択します。

   

4. スライダーを動かして日数を増減してから、[OK] を選択します。

Log Analytics ワークスペース内の Analytics テーブルの既定の対話型保持期間を設定するには、Workspaces - Create Or Update API を呼び出します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}?api-version=2023-09-01

要求本文

要求本文には、次の票の値が含まれています。

例

次の例では、ワークスペースの保持期間をワークスペースの既定の 30 日間に設定し、データが 30 日後に直ちに削除され回復不可能になることを確認します。

Request

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}?api-version=2023-09-01

{
  "properties": {
    "retentionInDays": 30,
    "features": {"immediatePurgeDataOn30Days": true}
    },
"location": "australiasoutheast"
}

**Response**

Status code: 200

```http
{
  "properties": {
    ...
    "retentionInDays": 30,
    "features": {
      "legacy": 0,
      "searchVersion": 1,
      "immediatePurgeDataOn30Days": true,
      ...
    },
    ...

Log Analytics ワークスペース内の Analytics テーブルの既定の対話型保持期間を設定するには、az monitor log-analytics workspace update コマンドを実行し、--retention-time パラメーターを渡します。

次の例では、テーブルの対話型リテンション期間を 30 日に設定します。

az monitor log-analytics workspace update --resource-group myresourcegroup --retention-time 30 --workspace-name myworkspace

Set-AzOperationalInsightsWorkspace コマンドレットを使用して、Log Analytics ワークスペース内の Analytics テーブルの既定の対話型保持期間を設定します。 次の例では、既定の対話型保持期間を 30 日間に設定します。

Set-AzOperationalInsightsWorkspace -ResourceGroupName "myResourceGroup" -Name "MyWorkspace" -RetentionInDays 30

Azure portal でテーブルの保持設定を変更するには:

1. [Log Analytics ワークスペース] メニューから [テーブル] を選択します。

   [テーブル] 画面には、ワークスペース内のすべてのテーブルが一覧表示されます。

2. 構成するテーブルのコンテキスト メニューを選択し、[テーブルの管理] を選択します。

   

3. テーブル構成画面の [データ保持設定] セクションで、対話型保持期間と合計保持期間の設定を構成します。

   

テーブルの保持設定を変更するには、Tables - Update API を呼び出します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}?api-version=2022-10-01

PUT または PATCH を使用できます。違いは次のとおりです。

• null 以外の値を設定しない場合、PUT API は retentionInDays と totalRetentionInDays を既定値に設定します。
• 値を指定しない場合、PATCH API は retentionInDays または totalRetentionInDays の値を変更しません。

要求本文

要求本文には、次の票の値が含まれています。

例

この例では、テーブルの対話型保持期間をワークスペースの既定値である 30 日間に、合計保持期間を 2 年間に設定します。これは長期保持期間が 23 か月間であることを意味します。

Request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/testRG/providers/Microsoft.OperationalInsights/workspaces/testWS/tables/CustomLog_CL?api-version=2022-10-01

要求本文

{
    "properties": {
        "retentionInDays": null,
        "totalRetentionInDays": 730
    }
}

応答

状態コード:200

{
    "properties": {
        "retentionInDays": 30,
        "totalRetentionInDays": 730,
        "archiveRetentionInDays": 700,
        ...        
    },
   ...
}

テーブルの保持設定を変更するには、az monitor log-analytics workspace table update コマンドを実行し、--retention-time および --total-retention-time パラメーターを渡します。

次の例では、テーブルの対話型保持期間を 30 日間に、合計保持期間を 2 年間に設定します。これは、長期保持期間が 23 か月間であることを意味します。

az monitor log-analytics workspace table update --subscription ContosoSID --resource-group ContosoRG --workspace-name ContosoWorkspace --name AzureMetrics --retention-time 30 --total-retention-time 730

ワークスペースの既定の対話型リテンション期間の値をテーブルに再適用し、合計リテンション期間を 0 にリセットするには、--retention-time パラメーターと --total-retention-time パラメーターを -1 に設定して、az monitor log-analytics workspace table update コマンドを実行します。

次に例を示します。

az monitor log-analytics workspace table update --subscription ContosoSID --resource-group ContosoRG --workspace-name ContosoWorkspace --name Syslog --retention-time -1 --total-retention-time -1

テーブルの保持設定を変更するには、Update-AzOperationalInsightsTable コマンドレットを使用します。 次の例では、テーブルの対話型保持期間を 30 日間に、合計保持期間を 2 年間に設定します。これは、長期保持期間が 23 か月間であることを意味します。

Update-AzOperationalInsightsTable -ResourceGroupName ContosoRG -WorkspaceName ContosoWorkspace -TableName AzureMetrics -RetentionInDays 30 -TotalRetentionInDays 730

ワークスペースの既定の対話型保持値をテーブルに再適用し、合計保持を 0 にリセットするには、-RetentionInDays および -TotalRetentionInDays パラメータを -1 に設定して Update-AzOperationalInsightsTable コマンドレットを実行します。

次に例を示します。

Update-AzOperationalInsightsTable -ResourceGroupName ContosoRG -WorkspaceName ContosoWorkspace -TableName Syslog -RetentionInDays -1 -TotalRetentionInDays -1

Azure portal でテーブルの保持設定を表示するには、[Log Analytics ワークスペース] メニューから [テーブル] を選択します。

[テーブル] 画面には、ワークスペース内のすべてのテーブルの対話型保持期間および合計保持期間が表示されます。

特定のテーブル (この例では SecurityEvent) の保持設定を取得するには、Tables - Get API を呼び出します。

GET /subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/MyResourceGroupName/providers/Microsoft.OperationalInsights/workspaces/MyWorkspaceName/Tables/SecurityEvent?api-version=2022-10-01

ワークスペース内のテーブルレベルの保持設定をすべて取得するには、テーブル名を設定しないでください。

次に例を示します。

GET /subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/MyResourceGroupName/providers/Microsoft.OperationalInsights/workspaces/MyWorkspaceName/Tables?api-version=2022-10-01

特定のテーブルの保持設定を取得するには、az monitor log-analytics workspace table show コマンドを実行します。

次に例を示します。

az monitor log-analytics workspace table show --subscription ContosoSID --resource-group ContosoRG --workspace-name ContosoWorkspace --name SecurityEvent

特定のテーブルの保持設定を取得するには、Get-AzOperationalInsightsTable コマンドレットを実行します。

次に例を示します。

Get-AzOperationalInsightsTable -ResourceGroupName ContosoRG -WorkspaceName ContosoWorkspace -tableName SecurityEvent