Dela via


Tables - Get

Hämtar en Log Analytics-arbetsytetabell.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

minLength: 1

ID för målprenumerationen.

tableName
path True

string

minLength: 4
maxLength: 63
pattern: ^[A-Za-z0-9-_]+$

Namnet på tabellen.

workspaceName
path True

string

minLength: 4
maxLength: 63
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

Namnet på arbetsytan.

api-version
query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

Table

OK svarsdefinition.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

TablesGet

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Column

Tabellkolumn.

ColumnDataTypeHintEnum

Logisk ledtråd för kolumndatatyp.

ColumnTypeEnum

Kolumndatatyp.

createdByType

Den typ av identitet som skapade resursen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ProvisioningStateEnum

Tabellens aktuella etableringstillstånd. Om värdet är inställt på "uppdatering" anger ett resurslås på grund av pågående åtgärd, vilket förbjuder alla uppdateringar till tabellen tills den pågående åtgärden har slutförts.

RestoredLogs

Återställ parametrar.

ResultStatistics

Körningsstatistik för sökjobb.

Schema

Tabellens schema.

SearchResults

Parametrar för sökjobbet som initierade den här tabellen.

SourceEnum

Tabellskapare.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Table

Definition av arbetsytans datatabell.

TablePlanEnum

Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.

TableSubTypeEnum

Undertypen beskriver vilka API:er som kan användas för att interagera med tabellen och vilka funktioner som är tillgängliga mot den.

TableTypeEnum

Tabellskapare.

Column

Tabellkolumn.

Name Typ Description
dataTypeHint

ColumnDataTypeHintEnum

Logisk ledtråd för kolumndatatyp.

description

string

Kolumnbeskrivning.

displayName

string

Kolumnvisningsnamn.

isDefaultDisplay

boolean

Visas som standard.

isHidden

boolean

Är kolumnen dold.

name

string

Kolumnnamn.

type

ColumnTypeEnum

Kolumndatatyp.

ColumnDataTypeHintEnum

Logisk ledtråd för kolumndatatyp.

Värde Description
armPath

En ARM-sökväg (Azure Resource Model): /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft. {...}/{...}/{...}/{...}...

guid

Ett standard-128-bitars GUID som följer standardformen xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ip

En standard-V4/V6 ip-adress som följer standardformen x.x.x.x/y:y:y:y:y:y:y:y

uri

En sträng som matchar mönstret för en URI, till exempel scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Kolumndatatyp.

Värde Description
boolean
dateTime
dynamic
guid
int
long
real
string

createdByType

Den typ av identitet som skapade resursen.

Värde Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ProvisioningStateEnum

Tabellens aktuella etableringstillstånd. Om värdet är inställt på "uppdatering" anger ett resurslås på grund av pågående åtgärd, vilket förbjuder alla uppdateringar till tabellen tills den pågående åtgärden har slutförts.

Värde Description
Deleting

Tabelltillståndet tas bort.

InProgress

Tabellschemat är stabilt och utan ändringar uppdateras tabelldata.

Succeeded

Tabelltillståndet är stabilt och utan ändringar låss tabellen upp och öppnas för nya uppdateringar.

Updating

Tabellschemat håller fortfarande på att skapas och uppdateras. Tabellen är för närvarande låst för alla ändringar tills proceduren är klar.

RestoredLogs

Återställ parametrar.

Name Typ Description
azureAsyncOperationId

string

Asynkront åtgärds-ID för sökresultattabell.

endRestoreTime

string (date-time)

Tidsstämpeln för att avsluta återställningen av (UTC).

sourceTable

string

Tabellen som data ska återställas från.

startRestoreTime

string (date-time)

Tidsstämpeln för att starta återställningen från (UTC).

ResultStatistics

Körningsstatistik för sökjobb.

Name Typ Description
ingestedRecords

integer (int32)

Antalet rader som returnerades av sökjobbet.

progress

number

multipleOf: 0.01

Slutförande av sökjobb i procent.

scannedGb

number

multipleOf: 0.01

Sökjobb: Mängden genomsökt data.

Schema

Tabellens schema.

Name Typ Description
categories

string[]

Tabellkategori.

columns

Column[]

En lista över anpassade tabellkolumner.

description

string

Tabellbeskrivning.

displayName

string

Tabellvisningsnamn.

labels

string[]

Tabelletiketter.

name

string

Tabellnamn.

solutions

string[]

Lista över lösningar som tabellen är kopplad till

source

SourceEnum

Tabellskapare.

standardColumns

Column[]

En lista över tabellstandardkolumner.

tableSubType

TableSubTypeEnum

Undertypen beskriver vilka API:er som kan användas för att interagera med tabellen och vilka funktioner som är tillgängliga mot den.

tableType

TableTypeEnum

Tabellskapare.

SearchResults

Parametrar för sökjobbet som initierade den här tabellen.

Name Typ Description
azureAsyncOperationId

string

Asynkront åtgärds-ID för sökresultattabell.

description

string

Beskrivning av sökjobb.

endSearchTime

string (date-time)

Tidsstämpeln för att avsluta sökningen med (UTC)

limit

integer (int32)

Begränsa sökjobbet så att det återgår till angivet antal rader.

query

string

Sökjobbsfråga.

sourceTable

string

Tabellen som används i sökjobbet.

startSearchTime

string (date-time)

Tidsstämpeln för att starta sökningen från (UTC)

SourceEnum

Tabellskapare.

Värde Description
customer

Tabeller som skapats av arbetsytans ägare och som bara finns i den här arbetsytan.

microsoft

Tabeller som tillhandahålls av systemet, som samlas in via diagnostikinställningar, agenter eller andra standarddatainsamlingsmedel.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

Table

Definition av arbetsytans datatabell.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.archiveRetentionInDays

integer (int32)

Kvarhållning av tabelldataarkiv i dagar. Beräknat som (totalRetentionInDays-retentionInDays)

properties.lastPlanModifiedDate

string

Tidsstämpeln som tabellplanen senast ändrades (UTC).

properties.plan

TablePlanEnum

Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.

properties.provisioningState

ProvisioningStateEnum

Tabellens aktuella etableringstillstånd. Om värdet är inställt på "uppdatering" anger ett resurslås på grund av pågående åtgärd, vilket förbjuder alla uppdateringar till tabellen tills den pågående åtgärden har slutförts.

properties.restoredLogs

RestoredLogs

Parametrar för återställningsåtgärden som initierade den här tabellen.

properties.resultStatistics

ResultStatistics

Körningsstatistik för sökjobb.

properties.retentionInDays

integer (int32)

minimum: 4
maximum: 730

Kvarhållning av tabeller i dagar, mellan 4 och 730. Om du anger den här egenskapen till -1 kommer kvarhållningen av arbetsytan som standard att vara kvar.

properties.retentionInDaysAsDefault

boolean

True – värdet kommer från kvarhållning av arbetsytor i dagar, False – Kundspecifik.

properties.schema

Schema

Tabellschema.

properties.searchResults

SearchResults

Parametrar för sökjobbet som initierade den här tabellen.

properties.totalRetentionInDays

integer (int32)

minimum: 4
maximum: 4383

Tabellens totala kvarhållning i dagar, mellan 4 och 4383. Om du anger den här egenskapen till -1 används som standard kvarhållning av tabeller.

properties.totalRetentionInDaysAsDefault

boolean

True – Värdet kommer från kvarhållning i dagar, False – Kundspecifik.

systemData

systemData

Metadata som rör skapande och senaste ändring av resursen.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

TablePlanEnum

Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.

Värde Description
Analytics

Loggar som tillåter övervakning och analys.

Basic

Loggar som justeras för att stödja utförliga loggar med låga volymvärden.

TableSubTypeEnum

Undertypen beskriver vilka API:er som kan användas för att interagera med tabellen och vilka funktioner som är tillgängliga mot den.

Värde Description
Any

Standardundertypen som inbyggda tabeller skapas med.

Classic

Anger en tabell som skapats via API:et för datainsamlare eller med funktionen för anpassade loggar i MMA-agenten eller någon tabell som anpassade fält skapades mot.

DataCollectionRuleBased

En tabell som är berättigad att få data skickade till den via något av de metoder som stöds av datainsamlingsregler: datainsamlingens slutpunkts-API, inmatningstidstransformeringar eller någon annan mekanism som tillhandahålls av datainsamlingsregler

TableTypeEnum

Tabellskapare.

Värde Description
CustomLog

Anpassad loggtabell.

Microsoft

Standarddata som samlas in av Azure Monitor.

RestoredLogs

Återställde data.

SearchResults

Data som samlas in av ett sökjobb.