Tables - Update

サービス:: Log Analytics

API バージョン:: 2025-02-01

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

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

URI パラメーター

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

要求本文

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

定義

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

Column

Object

テーブル列。

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

ColumnDataTypeHintEnum

列挙

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

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

ColumnTypeEnum

列挙

列データ型。

値	説明
string
int
long
real
boolean
dateTime
guid
dynamic

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ProvisioningStateEnum

列挙

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

値	説明
Updating	テーブルスキーマは引き続きビルドおよび更新中です。現在、プロシージャが完了するまで、テーブルは変更に対してロックされています。
InProgress	テーブルスキーマは安定しており、変更を加えずにテーブルデータが更新されます。
Succeeded	テーブルの状態は安定しており、変更なしで、テーブルはロック解除され、新しい更新のために開きます。
Deleting	テーブルの状態が削除中です。

RestoredLogs

Object

復元パラメーター。

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

ResultStatistics

Object

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

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

Schema

Object

テーブルのスキーマ。

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

SearchResults

Object

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

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

SourceEnum

列挙

テーブルの作成者。

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

systemData

Object

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

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

Table

Object

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

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

TablePlanEnum

列挙

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

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

TableSubTypeEnum

列挙

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

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

TableTypeEnum

列挙

テーブルの作成者。

値	説明
Microsoft	Azure Monitor によって収集された標準データ。
CustomLog	カスタムログテーブル。
RestoredLogs	復元されたデータ。
SearchResults	検索ジョブによって収集されたデータ。

次の方法で共有

Tables - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

TablesUpsert

要求のサンプル

応答のサンプル

定義

Column

ColumnDataTypeHintEnum

ColumnTypeEnum

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningStateEnum

RestoredLogs

ResultStatistics

Schema

SearchResults

SourceEnum

systemData

Table

TablePlanEnum

TableSubTypeEnum

TableTypeEnum