Tables - Update

リファレンス

サービス:: Log Analytics

API バージョン:: 2023-09-01

Log Analytics ワークスペーステーブルを更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
tableName	path	True	string	テーブルの名前。正規表現パターン: `^[A-Za-z0-9-_]+$`
workspaceName	path	True	string	ワークスペースの名前。正規表現パターン: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.plan	TablePlanEnum	このテーブルに取り込まれたログを処理して課金する方法をシステムに指示します。
properties.restoredLogs	RestoredLogs	このテーブルを開始した復元操作のパラメーター。
properties.retentionInDays	integer	4 から 730 までの日数でのテーブルの保持。このプロパティを -1 に設定すると、既定ではワークスペースの保持期間が設定されます。
properties.schema	Schema	テーブルスキーマ。
properties.searchResults	SearchResults	このテーブルを開始した検索ジョブのパラメーター。
properties.totalRetentionInDays	integer	4 から 4383 の間のテーブルの合計保有期間 (日数)。このプロパティを -1 に設定すると、既定ではテーブルの保持が設定されます。

応答

名前	型	説明
200 OK	Table	OK 応答の定義。
202 Accepted		受け入れられた応答の定義 (実行時間の長い操作)。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

TablesUpsert

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/AzureNetworkFlow?api-version=2023-09-01

{
  "properties": {
    "schema": {
      "name": "AzureNetworkFlow",
      "columns": [
        {
          "name": "MyNewColumn",
          "type": "guid"
        }
      ]
    },
    "retentionInDays": 45,
    "totalRetentionInDays": 70
  }
}

応答のサンプル

状態コード:: 200

{
  "properties": {
    "schema": {
      "name": "AzureNetworkFlow",
      "tableSubType": "DataCollectionRuleBased",
      "tableType": "Microsoft",
      "columns": [
        {
          "isHidden": false,
          "name": "MyNewColumn",
          "type": "guid",
          "isDefaultDisplay": false
        }
      ],
      "standardColumns": [
        {
          "isHidden": true,
          "name": "TenantId",
          "type": "guid",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceSystem",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TimeGenerated",
          "type": "dateTime",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "AgentID",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceIP",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Protocol",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourcePort",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "DestinationPort",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TcpFlags",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Packets",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Bytes",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "BytesOut",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "DurationInMs",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "RstCount",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "MaxSampleRtt",
          "type": "int",
          "isDefaultDisplay": false
        }
      ],
      "solutions": [
        "LogManagement"
      ]
    },
    "provisioningState": "Succeeded",
    "retentionInDays": 45,
    "totalRetentionInDays": 70,
    "archiveRetentionInDays": 25,
    "retentionInDaysAsDefault": false,
    "totalRetentionInDaysAsDefault": false,
    "plan": "Analytics"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/AzureNetworkFlow",
  "name": "AzureNetworkFlow"
}

状態コード:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.OperaitonalInsights/locations/eastus/operationstatuses/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-09-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperaitonalInsights/workspaces/oiautorest6685/tables/table1_CL/operationresults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-09-01

定義

名前	説明
Column	テーブル列。
ColumnDataTypeHintEnum	列データ型の論理ヒント。
ColumnTypeEnum	列データ型。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ProvisioningStateEnum	テーブルの現在のプロビジョニング状態。 'updating' に設定されている場合は、進行中の操作が終了するまでテーブルの更新を禁止する、進行中の操作によるリソースロックを示します。
RestoredLogs	復元パラメーター。
ResultStatistics	ジョブ実行統計を検索します。
Schema	テーブルのスキーマ。
SearchResults	このテーブルを開始した検索ジョブのパラメーター。
SourceEnum	テーブルの作成者。
systemData	リソースの作成と最後の変更に関連するメタデータ。
Table	ワークスペースデータテーブルの定義。
TablePlanEnum	このテーブルに取り込まれたログを処理して課金する方法をシステムに指示します。
TableSubTypeEnum	サブタイプは、テーブルの操作に使用できる API と、それに対して使用できる機能について説明します。
TableTypeEnum	テーブルの作成者。

Column

テーブル列。

名前	型	説明
dataTypeHint	ColumnDataTypeHintEnum	列データ型の論理ヒント。
description	string	列の説明。
displayName	string	列の表示名。
isDefaultDisplay	boolean	既定で表示されます。
isHidden	boolean	列は非表示です。
name	string	列名。
type	ColumnTypeEnum	列データ型。

ColumnDataTypeHintEnum

列データ型の論理ヒント。

名前	型	説明
armPath	string	Azure Resource Model (ARM) パス: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft。{...}/{...}/{...}/{...}...
guid	string	標準図形 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx に続く標準の 128 ビット GUID
ip	string	標準図形 x.x.x.x/y:y:y:y:y:y:y:y:y:y に続く標準 V4/V6 IP アドレス
uri	string	URI のパターンに一致する文字列 (k2=v2#fragment scheme://username:password@host:1234/this/is/a/path?k1=v1&など)

ColumnTypeEnum

列データ型。

名前	型	説明
boolean	string
dateTime	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

ProvisioningStateEnum

テーブルの現在のプロビジョニング状態。 'updating' に設定されている場合は、進行中の操作が終了するまでテーブルの更新を禁止する、進行中の操作によるリソースロックを示します。

名前	型	説明
Deleting	string	テーブルの状態が削除されています。
InProgress	string	テーブルスキーマは安定しており、変更なしでテーブルデータが更新されています。
Succeeded	string	テーブルの状態は安定しており、変更はありません。テーブルはロックが解除され、新しい更新プログラム用に開きます。
Updating	string	テーブルスキーマは引き続きビルドおよび更新中です。プロシージャが完了するまで、テーブルは現在変更に対してロックされています。

RestoredLogs

復元パラメーター。

名前	型	説明
azureAsyncOperationId	string	検索結果テーブルの非同期操作 ID。
endRestoreTime	string	復元を終了するタイムスタンプ (UTC)。
sourceTable	string	データを復元するテーブル。
startRestoreTime	string	復元を開始するタイムスタンプ (UTC)。

ResultStatistics

ジョブ実行統計を検索します。

名前	型	説明
ingestedRecords	integer	検索ジョブによって返された行の数。
progress	number	検索ジョブの完了率。
scannedGb	number	検索ジョブ: スキャンされたデータの量。

Schema

テーブルのスキーマ。

名前	型	説明
categories	string[]	テーブルカテゴリ。
columns	Column[]	テーブルのカスタム列の一覧。
description	string	テーブルの説明。
displayName	string	テーブルの表示名。
labels	string[]	テーブルラベル。
name	string	テーブル名。
solutions	string[]	テーブルが関連付けされているソリューションの一覧
source	SourceEnum	テーブルの作成者。
standardColumns	Column[]	テーブルの標準列の一覧。
tableSubType	TableSubTypeEnum	サブタイプは、テーブルの操作に使用できる API と、それに対して使用できる機能について説明します。
tableType	TableTypeEnum	テーブルの作成者。

SearchResults

このテーブルを開始した検索ジョブのパラメーター。

名前	型	説明
azureAsyncOperationId	string	検索結果テーブルの非同期操作 ID。
description	string	検索ジョブの説明。
endSearchTime	string	検索を終了するタイムスタンプ (UTC)
limit	integer	指定した行数まで返すように検索ジョブを制限します。
query	string	検索ジョブクエリ。
sourceTable	string	検索ジョブで使用されるテーブル。
startSearchTime	string	検索を開始するタイムスタンプ (UTC)

SourceEnum

テーブルの作成者。

名前	型	説明
customer	string	ワークスペースの所有者によって作成され、このワークスペースでのみ見つかったテーブル。
microsoft	string	診断設定、エージェント、またはその他の標準データ収集手段を使用して収集された、システムによってプロビジョニングされたテーブル。

systemData

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

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Table

ワークスペースデータテーブルの定義。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.archiveRetentionInDays	integer	テーブルデータアーカイブの保持期間 (日数)。として計算されます (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	テーブルプランが最後に変更されたタイムスタンプ (UTC)。
properties.plan	TablePlanEnum	このテーブルに取り込まれたログを処理して課金する方法をシステムに指示します。
properties.provisioningState	ProvisioningStateEnum	テーブルの現在のプロビジョニング状態。 'updating' に設定されている場合は、進行中の操作が終了するまでテーブルの更新を禁止する、進行中の操作によるリソースロックを示します。
properties.restoredLogs	RestoredLogs	このテーブルを開始した復元操作のパラメーター。
properties.resultStatistics	ResultStatistics	ジョブ実行統計を検索します。
properties.retentionInDays	integer	4 から 730 までの日数でのテーブルの保持。このプロパティを -1 に設定すると、既定ではワークスペースの保持期間が設定されます。
properties.retentionInDaysAsDefault	boolean	True - 値はワークスペースの保有期間 (日数) から取得され、False - 顧客固有です。
properties.schema	Schema	テーブルスキーマ。
properties.searchResults	SearchResults	このテーブルを開始した検索ジョブのパラメーター。
properties.totalRetentionInDays	integer	4 から 4383 の間のテーブルの合計保有期間 (日数)。このプロパティを -1 に設定すると、既定ではテーブルの保持が設定されます。
properties.totalRetentionInDaysAsDefault	boolean	True - 値は日単位の保持から発生し、False - 顧客固有です。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

TablePlanEnum

このテーブルに取り込まれたログを処理して課金する方法をシステムに指示します。

名前	型	説明
Analytics	string	監視と分析を可能にするログ。
Basic	string	大量の低い値の詳細ログをサポートするように調整されたログ。

TableSubTypeEnum

サブタイプは、テーブルの操作に使用できる API と、それに対して使用できる機能について説明します。

名前	型	説明
Any	string	組み込みテーブルが作成される既定のサブタイプ。
Classic	string	データコレクター API または MMA エージェントのカスタムログ機能を使用して作成されたテーブル、またはユーザー設定フィールドが作成されたテーブルを示します。
DataCollectionRuleBased	string	データ収集ルールでサポートされている手段 (データ収集エンドポイント API、インジェスト時変換、またはデータ収集ルールによって提供されるその他のメカニズム) を介してデータを送信できるテーブル

TableTypeEnum