Freigeben über


Tables - Get

Ruft eine Log Analytics-Arbeitsbereichstabelle ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

tableName
path True

string

Der Name der Tabelle.

RegEx-Muster: ^[A-Za-z0-9-_]+$

workspaceName
path True

string

Den Namen des Arbeitsbereichs

RegEx-Muster: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

Table

OK-Antwortdefinition.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

TablesGet

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Column

Tabellenspalte.

ColumnDataTypeHintEnum

Logischer Hinweis des Spaltendatentyps.

ColumnTypeEnum

Spaltendatentyp.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

ProvisioningStateEnum

Der aktuelle Bereitstellungsstatus der Tabelle. Wenn auf "aktualisieren" festgelegt ist, wird eine Ressourcensperre aufgrund des laufenden Vorgangs angezeigt, die jegliche Aktualisierung der Tabelle verbietet, bis der laufende Vorgang abgeschlossen ist.

RestoredLogs

Parameter wiederherstellen.

ResultStatistics

Statistiken zur Ausführung von Suchaufträgen.

Schema

Das Schema der Tabelle.

SearchResults

Parameter des Suchauftrags, der diese Tabelle initiiert hat.

SourceEnum

Ersteller der Tabelle.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Table

Definition der Arbeitsbereichsdatentabelle.

TablePlanEnum

Weisen Sie das System an, wie die in dieser Tabelle erfassten Protokolle verarbeitet und aufgeladen werden sollen.

TableSubTypeEnum

Der Untertyp beschreibt, welche APIs für die Interaktion mit der Tabelle verwendet werden können und welche Features dafür verfügbar sind.

TableTypeEnum

Ersteller der Tabelle.

Column

Tabellenspalte.

Name Typ Beschreibung
dataTypeHint

ColumnDataTypeHintEnum

Logischer Hinweis für den Spaltendatentyp.

description

string

Spaltenbeschreibung.

displayName

string

Spaltenanzeigename.

isDefaultDisplay

boolean

Wird standardmäßig angezeigt.

isHidden

boolean

Spalte ausgeblendet.

name

string

Spaltenname.

type

ColumnTypeEnum

Spaltendatentyp.

ColumnDataTypeHintEnum

Logischer Hinweis des Spaltendatentyps.

Name Typ Beschreibung
armPath

string

Ein ARM-Pfad (Azure Resource Model): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...

guid

string

Eine Standardmäßige 128-Bit-GUID nach der Standardform xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx

ip

string

Eine Standard-V4/V6-IP-Adresse, die der Standardform folgt, x.x.x.x/y:y:y:y:y:y:y:y:y

uri

string

Eine Zeichenfolge, die dem Muster eines URI entspricht, z. B. scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Spaltendatentyp.

Name Typ Beschreibung
boolean

string

dateTime

string

dynamic

string

guid

string

int

string

long

string

real

string

string

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

ProvisioningStateEnum

Der aktuelle Bereitstellungsstatus der Tabelle. Wenn auf "aktualisieren" festgelegt ist, wird eine Ressourcensperre aufgrund des laufenden Vorgangs angezeigt, die jegliche Aktualisierung der Tabelle verbietet, bis der laufende Vorgang abgeschlossen ist.

Name Typ Beschreibung
Deleting

string

Der Tabellenstatus wird gelöscht.

InProgress

string

Das Tabellenschema ist stabil, und ohne Änderungen werden die Tabellendaten aktualisiert.

Succeeded

string

Der Tabellenstatus ist stabil und ohne Änderungen ist die Tabelle entsperrt und für neue Updates geöffnet.

Updating

string

Das Tabellenschema wird noch erstellt und aktualisiert, die Tabelle ist derzeit für alle Änderungen gesperrt, bis die Prozedur abgeschlossen ist.

RestoredLogs

Parameter wiederherstellen.

Name Typ Beschreibung
azureAsyncOperationId

string

Asynchrone Vorgangs-ID der Suchergebnissentabelle.

endRestoreTime

string

Der Zeitstempel zum Beenden der Wiederherstellung durch (UTC).

sourceTable

string

Die Tabelle, aus der Daten wiederhergestellt werden sollen.

startRestoreTime

string

Der Zeitstempel zum Starten der Wiederherstellung von (UTC).

ResultStatistics

Statistiken zur Ausführung von Suchaufträgen.

Name Typ Beschreibung
ingestedRecords

integer

Die Anzahl der Zeilen, die vom Suchauftrag zurückgegeben wurden.

progress

number

Prozentsatz des Abschlusses von Suchaufträgen.

scannedGb

number

Suchauftrag: Menge der gescannten Daten.

Schema

Das Schema der Tabelle.

Name Typ Beschreibung
categories

string[]

Tabellenkategorie.

columns

Column[]

Eine Liste benutzerdefinierter Tabellenspalten.

description

string

Tabellenbeschreibung.

displayName

string

Tabellenanzeigename.

labels

string[]

Tabellenbezeichnungen.

name

string

Tabellenname.

solutions

string[]

Liste der Lösungen, denen die Tabelle zugeordnet ist

source

SourceEnum

Ersteller der Tabelle.

standardColumns

Column[]

Eine Liste der Tabellenstandardspalten.

tableSubType

TableSubTypeEnum

Der Untertyp beschreibt, welche APIs für die Interaktion mit der Tabelle verwendet werden können und welche Features dafür verfügbar sind.

tableType

TableTypeEnum

Ersteller der Tabelle.

SearchResults

Parameter des Suchauftrags, der diese Tabelle initiiert hat.

Name Typ Beschreibung
azureAsyncOperationId

string

Asynchrone Vorgangs-ID der Suchergebnissentabelle.

description

string

Auftragsbeschreibung suchen.

endSearchTime

string

Der Zeitstempel zum Beenden der Suche nach (UTC)

limit

integer

Beschränken Sie den Suchauftrag auf die angegebene Anzahl von Zeilen.

query

string

Suchauftragsabfrage.

sourceTable

string

Die im Suchauftrag verwendete Tabelle.

startSearchTime

string

Der Zeitstempel zum Starten der Suche von (UTC)

SourceEnum

Ersteller der Tabelle.

Name Typ Beschreibung
customer

string

Tabellen, die vom Besitzer des Arbeitsbereichs erstellt wurden und nur in diesem Arbeitsbereich gefunden wurden.

microsoft

string

Vom System bereitgestellte Tabellen, die über Diagnoseeinstellungen, die Agents oder andere Standarddatensammlungsmittel gesammelt werden.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Table

Definition der Arbeitsbereichsdatentabelle.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.archiveRetentionInDays

integer

Die Aufbewahrung von Tabellendatenarchiven in Tagen. Berechnet als (totalRetentionInDays-retentionInDays)

properties.lastPlanModifiedDate

string

Der Zeitstempel, der für den Tabellenplan zuletzt geändert wurde (UTC).

properties.plan

TablePlanEnum

Weisen Sie das System an, wie die in dieser Tabelle erfassten Protokolle verarbeitet und aufgeladen werden sollen.

properties.provisioningState

ProvisioningStateEnum

Der aktuelle Bereitstellungsstatus der Tabelle. Wenn auf "aktualisieren" festgelegt ist, wird eine Ressourcensperre aufgrund des laufenden Vorgangs angezeigt, die jegliche Aktualisierung der Tabelle verbietet, bis der laufende Vorgang abgeschlossen ist.

properties.restoredLogs

RestoredLogs

Parameter des Wiederherstellungsvorgangs, der diese Tabelle initiiert hat.

properties.resultStatistics

ResultStatistics

Statistiken zur Ausführung von Suchaufträgen.

properties.retentionInDays

integer

Die Tabellenaufbewahrung in Tagen zwischen 4 und 730. Wenn Sie diese Eigenschaft auf -1 festlegen, wird standardmäßig die Arbeitsbereichsaufbewahrung festgelegt.

properties.retentionInDaysAsDefault

boolean

True : Der Wert stammt aus der Arbeitsbereichsaufbewahrung in Tagen, False – Kundenspezifisch.

properties.schema

Schema

Tabellenschema

properties.searchResults

SearchResults

Parameter des Suchauftrags, der diese Tabelle initiiert hat.

properties.totalRetentionInDays

integer

Die Gesamtaufbewahrung der Tabelle in Tagen zwischen 4 und 4383. Wenn Sie diese Eigenschaft auf -1 festlegen, wird standardmäßig die Tabellenaufbewahrung verwendet.

properties.totalRetentionInDaysAsDefault

boolean

True : Der Wert stammt aus der Aufbewahrung in Tagen, False – Kundenspezifisch.

systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

TablePlanEnum

Weisen Sie das System an, wie die in dieser Tabelle erfassten Protokolle verarbeitet und aufgeladen werden sollen.

Name Typ Beschreibung
Analytics

string

Protokolle, die Überwachung und Analyse ermöglichen.

Basic

string

Protokolle, die so angepasst sind, dass ausführliche Protokolle mit hohem Volumen mit geringem Wert unterstützt werden.

TableSubTypeEnum

Der Untertyp beschreibt, welche APIs für die Interaktion mit der Tabelle verwendet werden können und welche Features dafür verfügbar sind.

Name Typ Beschreibung
Any

string

Der Standarduntertyp, mit dem integrierte Tabellen erstellt werden.

Classic

string

Gibt eine Tabelle an, die über die Datensammler-API oder mit dem Feature benutzerdefinierte Protokolle des MMA-Agents oder eine beliebige Tabelle erstellt wurde, für die benutzerdefinierte Felder erstellt wurden.

DataCollectionRuleBased

string

Eine Tabelle, die berechtigt ist, Daten über eine der von Datensammlungsregeln unterstützten Mittel an sie zu senden: die Datensammlungsendpunkt-API, Erfassungszeittransformationen oder ein anderer mechanismus, der von Datensammlungsregeln bereitgestellt wird.

TableTypeEnum

Ersteller der Tabelle.

Name Typ Beschreibung
CustomLog

string

Benutzerdefinierte Protokolltabelle.

Microsoft

string

Von Azure Monitor gesammelte Standarddaten.

RestoredLogs

string

Wiederhergestellte Daten.

SearchResults

string

Von einem Suchauftrag erfasste Daten.