Tables - Get

Service:

Log Analytics

API Version:

2022-10-01

Lekéri a Log Analytics-munkaterület táblát.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
tableName	path	True	string	A tábla neve.
workspaceName	path	True	string	A munkaterület neve. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	Table	OK válaszdefiníció.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

TablesGet

Sample Request

HTTP

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

Java

/** 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

Python

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

JavaScript

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

dotnet

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"
}

Definíciók

Name	Description
Column	Táblaoszlop.
ColumnDataTypeHintEnum	Oszlop adattípusának logikai tippje.
ColumnTypeEnum	Oszlop adattípusa.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ProvisioningStateEnum	A tábla aktuális kiépítési állapota. Ha a "frissítés" értékre van állítva, a folyamatban lévő művelet miatt erőforrás-zárolást jelez, amely megtiltja a tábla frissítését a folyamatban lévő művelet befejezéséig.
RestoredLogs	Paraméterek visszaállítása.
ResultStatistics	Keresési feladatok végrehajtási statisztikái.
Schema	Tábla sémája.
SearchResults	A táblát kezdeményező keresési feladat paraméterei.
SourceEnum	A tábla létrehozója.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Table	Munkaterület adattáblájának definíciója.
TablePlanEnum	Utasítsa a rendszert, hogyan kezelje és számítsa fel a táblába betöltött naplókat.
TableSubTypeEnum	Az altípus azt írja le, hogy milyen API-k használhatók a táblával való interakcióhoz, és milyen funkciók érhetők el rajta.
TableTypeEnum	A tábla létrehozója.

Column

Táblaoszlop.

Name	Típus	Description
dataTypeHint	ColumnDataTypeHintEnum	Oszlop adattípusának logikai tippje.
description	string	Oszlop leírása.
displayName	string	Oszlop megjelenítendő neve.
isDefaultDisplay	boolean	Alapértelmezés szerint megjelenik.
isHidden	boolean	Az oszlop rejtett.
name	string	Oszlop neve.
type	ColumnTypeEnum	Oszlop adattípusa.

ColumnDataTypeHintEnum

Oszlop adattípusának logikai tippje.

Name	Típus	Description
armPath	string	Egy Azure-erőforrásmodell (ARM) elérési útja: /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	Szabványos 128 bites GUID a szabványos alakzat (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx) után
ip	string	Standard V4/V6 IP-cím a szabványos alakzatot követve, x.x.x.x/y:y:y:y:y:y:y:y
uri	string	Egy URI mintájának megfelelő sztring, például scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Oszlop adattípusa.

Name	Típus	Description
boolean	string
dateTime	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ProvisioningStateEnum

A tábla aktuális kiépítési állapota. Ha a "frissítés" értékre van állítva, a folyamatban lévő művelet miatt erőforrás-zárolást jelez, amely megtiltja a tábla frissítését a folyamatban lévő művelet befejezéséig.

Name	Típus	Description
Deleting	string	A tábla állapota törölve van.
InProgress	string	A táblaséma stabil, és módosítások nélkül a táblaadatok frissítése folyamatban van.
Succeeded	string	A tábla állapota stabil és módosítások nélkül, a tábla zárolása feloldva van, és meg van nyitva az új frissítésekhez.
Updating	string	A táblaséma létrehozása és frissítése még folyamatban van, a tábla jelenleg zárolva van a módosításokhoz, amíg az eljárás be nem fejeződik.

RestoredLogs

Paraméterek visszaállítása.

Name	Típus	Description
azureAsyncOperationId	string	Keresési eredmények táblája aszinkron művelet azonosítója.
endRestoreTime	string	A visszaállítás befejezésének időbélyege (UTC).
sourceTable	string	A táblát, amelyből adatokat szeretne visszaállítani.
startRestoreTime	string	A visszaállítás indításának időbélyege (UTC).

ResultStatistics

Keresési feladatok végrehajtási statisztikái.

Name	Típus	Description
ingestedRecords	integer	A keresési feladat által visszaadott sorok száma.
progress	number	Keresési feladat befejezésének százalékos aránya.
scannedGb	number	Keresési feladat: A beolvasott adatok mennyisége.

Schema

Tábla sémája.

Name	Típus	Description
categories	string[]	Táblakategória.
columns	Column[]	Egyéni táblázatoszlopok listája.
description	string	Táblázat leírása.
displayName	string	Tábla megjelenítendő neve.
labels	string[]	Táblafeliratok.
name	string	Tábla neve.
solutions	string[]	Azoknak a megoldásoknak a listája, amellyel a táblázat kapcsolódik
source	SourceEnum	A tábla létrehozója.
standardColumns	Column[]	A szabványos táblázatoszlopok listája.
tableSubType	TableSubTypeEnum	Az altípus azt írja le, hogy milyen API-k használhatók a táblával való interakcióhoz, és milyen funkciók érhetők el rajta.
tableType	TableTypeEnum	A tábla létrehozója.

SearchResults

A táblát kezdeményező keresési feladat paraméterei.

Name	Típus	Description
azureAsyncOperationId	string	Keresési eredmények táblája aszinkron művelet azonosítója.
description	string	Keresési feladat leírása.
endSearchTime	string	A keresés befejezésének időbélyege (UTC)
limit	integer	Korlátozza a keresési feladat visszaadását megadott számú sorra.
query	string	Keresési feladat lekérdezése.
sourceTable	string	A keresési feladatban használt tábla.
startSearchTime	string	A keresés indításának időbélyege (UTC)

SourceEnum

A tábla létrehozója.

Name	Típus	Description
customer	string	A munkaterület tulajdonosa által létrehozott táblák, és csak ebben a munkaterületen találhatók.
microsoft	string	A rendszer által kiépített táblák, amelyeket a diagnosztikai beállítások, az ügynökök vagy bármely más szabványos adatgyűjtési eszköz gyűjt.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Table

Munkaterület adattáblájának definíciója.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.archiveRetentionInDays	integer	A táblaadat-archiválás megőrzési ideje napokban. Számított érték (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	A táblázatterv utolsó módosításának időbélyege (UTC).
properties.plan	TablePlanEnum	Utasítsa a rendszert, hogyan kezelje és számítsa fel a táblába betöltött naplókat.
properties.provisioningState	ProvisioningStateEnum	A tábla aktuális kiépítési állapota. Ha a "frissítés" értékre van állítva, a folyamatban lévő művelet miatt erőforrás-zárolást jelez, amely megtiltja a tábla frissítését a folyamatban lévő művelet befejezéséig.
properties.restoredLogs	RestoredLogs	A táblát kezdeményező visszaállítási művelet paraméterei.
properties.resultStatistics	ResultStatistics	Keresési feladatok végrehajtási statisztikái.
properties.retentionInDays	integer	A tábla megőrzési ideje napokban, 4 és 730 között. Ha ezt a tulajdonságot -1 értékre állítja, akkor alapértelmezés szerint a munkaterület adatmegőrzési értéke lesz.
properties.retentionInDaysAsDefault	boolean	Igaz – Az érték a munkaterület napokban történő megőrzéséből származik, Hamis – Ügyfélspecifikus.
properties.schema	Schema	Táblaséma.
properties.searchResults	SearchResults	A táblát kezdeményező keresési feladat paraméterei.
properties.totalRetentionInDays	integer	A tábla teljes megőrzési ideje napokban, 4 és 4383 között. Ha ezt a tulajdonságot -1 értékre állítja, az alapértelmezés szerint táblamegtartás lesz.
properties.totalRetentionInDaysAsDefault	boolean	Igaz – Az érték a megőrzésből származik napokban, Hamis – Ügyfélspecifikus.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

TablePlanEnum

Utasítsa a rendszert, hogyan kezelje és számítsa fel a táblába betöltött naplókat.

Name	Típus	Description
Analytics	string	Figyelést és elemzést lehetővé tevő naplók.
Basic	string	A nagy mennyiségű, alacsony értékű részletes naplók támogatásához igazított naplók.

TableSubTypeEnum

Az altípus azt írja le, hogy milyen API-k használhatók a táblával való interakcióhoz, és milyen funkciók érhetők el rajta.

Name	Típus	Description
Any	string	Az alapértelmezett altípus, amellyel a beépített táblák létrejönnek.
Classic	string	A Data Collector API-n vagy az MMA-ügynök egyéni naplók funkciójával létrehozott táblát, vagy bármely táblát jelöl, amelyhez egyéni mezőket hoztak létre.
DataCollectionRuleBased	string	Olyan tábla, amely jogosult arra, hogy az adatgyűjtési szabályok által támogatott eszközök bármelyikén keresztül adatokat küldjenek neki: az adatgyűjtési végpont API-ját, a betöltési idő átalakítását vagy az adatgyűjtési szabályok által biztosított bármely más mechanizmust

TableTypeEnum

A tábla létrehozója.

Name	Típus	Description
CustomLog	string	Egyéni naplótábla.
Microsoft	string	Az Azure Monitor által gyűjtött standard adatok.
RestoredLogs	string	Visszaállított adatok.
SearchResults	string	Keresési feladat által gyűjtött adatok.