Tables - Get

リファレンス

Service:: Log Analytics

API Version:: 2022-10-01

Log Analytics ワークスペーステーブルを取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	Table	OK 応答の定義。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

例

TablesGet

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/table1_SRCH?api-version=2022-10-01

/** Samples for Tables Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.json
     */
    /**
     * Sample code: TablesGet.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void tablesGet(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager
            .tables()
            .getWithResponse("oiautorest6685", "oiautorest6685", "table1_SRCH", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python tables_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-00000000000",
    )

    response = client.tables.get(
        resource_group_name="oiautorest6685",
        workspace_name="oiautorest6685",
        table_name="table1_SRCH",
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { OperationalInsightsManagementClient } = require("@azure/arm-operationalinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a Log Analytics workspace table.
 *
 * @summary Gets a Log Analytics workspace table.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.json
 */
async function tablesGet() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-00000000000";
  const resourceGroupName = process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "oiautorest6685";
  const workspaceName = "oiautorest6685";
  const tableName = "table1_SRCH";
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.tables.get(resourceGroupName, workspaceName, tableName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.OperationalInsights;
using Azure.ResourceManager.OperationalInsights.Models;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.json
// this example is just showing the usage of "Tables_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this OperationalInsightsTableResource created on azure
// for more information of creating OperationalInsightsTableResource, please refer to the document of OperationalInsightsTableResource
string subscriptionId = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "oiautorest6685";
string workspaceName = "oiautorest6685";
string tableName = "table1_SRCH";
ResourceIdentifier operationalInsightsTableResourceId = OperationalInsightsTableResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, tableName);
OperationalInsightsTableResource operationalInsightsTable = client.GetOperationalInsightsTableResource(operationalInsightsTableResourceId);

// invoke the operation
OperationalInsightsTableResource result = await operationalInsightsTable.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
OperationalInsightsTableData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "systemData": {
    "createdBy": "00000000-0000-0000-0000-00000000000",
    "createdAt": "2020-02-03T04:05:06Z"
  },
  "properties": {
    "resultStatistics": {
      "progress": 75,
      "ingestedRecords": 5,
      "scannedGb": 23.5
    },
    "searchResults": {
      "query": "Heartbeat | where SourceSystem != '' | project SourceSystem",
      "description": "This table was created using a Search Job with the following query: 'Heartbeat | where SourceSystem != '' | project SourceSystem'.",
      "limit": 1000,
      "startSearchTime": "2020-02-03T04:05:06Z",
      "endSearchTime": "2020-02-02T04:05:06Z",
      "sourceTable": "Heartbeat"
    },
    "schema": {
      "name": "table1_SRCH",
      "tableSubType": "DataCollectionRuleBased",
      "tableType": "SearchResults",
      "displayName": null,
      "description": null,
      "columns": [],
      "standardColumns": [
        {
          "isHidden": false,
          "name": "TenantId",
          "type": "guid",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceSystem",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "MG",
          "type": "guid",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "ManagementGroupName",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TimeGenerated",
          "type": "dateTime",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Computer",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "RawData",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        }
      ],
      "categories": null,
      "labels": null,
      "source": null,
      "solutions": [
        "LogManagement"
      ]
    },
    "provisioningState": "InProgress",
    "retentionInDays": 50,
    "totalRetentionInDays": 50,
    "archiveRetentionInDays": 0,
    "retentionInDaysAsDefault": false,
    "totalRetentionInDaysAsDefault": true,
    "plan": "Analytics"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/table1_SRCH",
  "name": "table1_SRCH"
}

定義

名前	説明
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 リソースモデル (ARM) パス: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft。{...}/{...}/{...}/{...}...
guid	string	標準図形に続く標準の 128 ビット GUID、xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ip	string	標準図形 x.x.x.x/y: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

テーブルの作成者。

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

Tables - Get

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

TablesGet

Sample Request

Sample Response

定義

Column

ColumnDataTypeHintEnum

ColumnTypeEnum

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningStateEnum

RestoredLogs

ResultStatistics

Schema

SearchResults

SourceEnum

systemData

Table

TablePlanEnum

TableSubTypeEnum

TableTypeEnum

その他のリソース