Workspaces - List

Hämtar arbetsytorna i en prenumeration.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces?api-version=2025-07-01

URI-parametrar

Name I Obligatorisk Typ Description
subscriptionId
path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.

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

WorkspaceListResult

Azure-operationen slutfördes framgångsrikt.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

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

WorkspacesSubscriptionList

Exempelbegäran

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.OperationalInsights/workspaces?api-version=2025-07-01

Exempelsvar

{
  "value": [
    {
      "name": "AzTest2170",
      "type": "Microsoft.OperationalInsights/workspaces",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
      "location": "australiasoutheast",
      "properties": {
        "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
        "provisioningState": "Succeeded",
        "publicNetworkAccessForIngestion": "Enabled",
        "publicNetworkAccessForQuery": "Enabled",
        "retentionInDays": 30,
        "sku": {
          "name": "PerGB2018"
        }
      },
      "tags": {
        "tag1": "val1"
      }
    }
  ]
}

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.

DataIngestionStatus

Status för datainmatning för den här arbetsytan.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

Identity

Identitet för resursen.

IdentityType

Typ av hanterad tjänstidentitet.

PrivateLinkScopedResource

Resursreferensen för private link-omfånget.

PublicNetworkAccessType

Nätverksåtkomsttypen för åtkomst till Log Analytics-inmatning.

systemData

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

UserIdentityProperties

Användartilldelade identitetsegenskaper.

Workspace

Resurscontainern för arbetsytan på den översta nivån.

WorkspaceCapping

Det dagliga volymtaket för inmatning.

WorkspaceEntityStatus

Etableringstillståndet för arbetsytan.

WorkspaceFailoverProperties

Redundanstillståndet för replikeringen.

WorkspaceFailoverState

Redundanstillståndet för replikeringen.

WorkspaceFeatures

Arbetsytefunktioner.

WorkspaceListResult

Åtgärdssvaret för listarbetsytorna.

WorkspaceReplicationProperties

Egenskaper för replikering av arbetsyta.

WorkspaceReplicationState

Etableringstillståndet för replikeringen.

WorkspaceSku

SKU:n (nivån) för en arbetsyta.

WorkspaceSkuNameEnum

Namnet på SKU:n.

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

DataIngestionStatus

Status för datainmatning för den här arbetsytan.

Värde Description
RespectQuota

Inmatning aktiverad efter återställning av daglig takkvot eller prenumerationsaktivering.

ForceOn

Inmatningen startade efter att tjänstinställningarna ändrades.

ForceOff

Inmatningen stoppades efter ändring av tjänstinställningen.

OverQuota

Kvoten för dagligt tak har nåtts, inmatningen stoppades.

SubscriptionSuspended

Inmatningen stoppades efter den inaktiverade prenumerationen.

ApproachingQuota

80% av den dagliga takkvoten har uppnåtts.

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.

Identity

Identitet för resursen.

Name Typ Description
principalId

string

Huvud-ID för resursidentitet.

tenantId

string

Resursens klientorganisations-ID.

type

IdentityType

Typ av hanterad tjänstidentitet.

userAssignedIdentities

<string,  UserIdentityProperties>

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Typ av hanterad tjänstidentitet.

Värde Description
SystemAssigned

Systemtilldelad

UserAssigned

UserAssigned

None

None

PrivateLinkScopedResource

Resursreferensen för private link-omfånget.

Name Typ Description
resourceId

string

Det fullständiga resurs-ID:t för resursen för den privata länkomfånget.

scopeId

string

Den unika identifieraren för omfånget för den privata länken.

PublicNetworkAccessType

Nätverksåtkomsttypen för åtkomst till Log Analytics-inmatning.

Värde Description
Enabled

Möjliggör anslutning till Log Analytics via offentlig DNS.

Disabled

Inaktiverar offentlig anslutning till Log Analytics via offentlig DNS.

SecuredByPerimeter

Resursen är endast tillgänglig från privata nätverk och åtkomst som godkänts av nätverkssäkerhetsperimetern som är associerad med den här resursen.

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.

UserIdentityProperties

Användartilldelade identitetsegenskaper.

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet.

principalId

string

Huvud-ID för användartilldelad identitet.

Workspace

Resurscontainern för arbetsytan på den översta nivån.

Name Typ Standardvärde Description
etag

string

Etag för arbetsytan.

id

string (arm-id)

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

identity

Identity

Resursens identitet.

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.createdDate

string (date-time)

Datum då arbetsytan skapades.

properties.customerId

string

Det här är en skrivskyddad egenskap. Representerar det ID som är associerat med arbetsytan.

properties.defaultDataCollectionRuleResourceId

string

Resurs-ID för standardregeln för datainsamling som ska användas för den här arbetsytan. Förväntat format är – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.

properties.failover

WorkspaceFailoverProperties

redundansegenskaper för arbetsytan.

properties.features

WorkspaceFeatures

Arbetsytefunktioner.

properties.forceCmkForQuery

boolean

Anger om kundhanterad lagring är obligatorisk för frågehantering.

properties.modifiedDate

string (date-time)

Ändringsdatum för arbetsyta.

properties.privateLinkScopedResources

PrivateLinkScopedResource[]

Lista över resurser för länkat omfång för privata länkar.

properties.provisioningState

WorkspaceEntityStatus

Etableringstillståndet för arbetsytan.

properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Enabled

Nätverksåtkomsttypen för åtkomst till Log Analytics-inmatning.

properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Enabled

Nätverksåtkomsttypen för åtkomst till Log Analytics-frågan.

properties.replication

WorkspaceReplicationProperties

replikeringsegenskaper för arbetsytan.

properties.retentionInDays

integer (int32)

Antal dagar för lagring av data på arbetsytan. Tillåtna värden är per prisplan. Mer information finns i dokumentationen om prisnivåer.

properties.sku

WorkspaceSku

Arbetsytans SKU.

properties.workspaceCapping

WorkspaceCapping

Det dagliga volymtaket för inmatning.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Resursetiketter.

type

string

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

WorkspaceCapping

Det dagliga volymtaket för inmatning.

Name Typ Description
dailyQuotaGb

number (double)

Den dagliga arbetsytans kvot för inmatning.

dataIngestionStatus

DataIngestionStatus

Status för datainmatning för den här arbetsytan.

quotaNextResetTime

string

Den tid då kvoten ska vara vila.

WorkspaceEntityStatus

Etableringstillståndet för arbetsytan.

Värde Description
Creating

Skapar

Succeeded

lyckades

Failed

Misslyckades

Canceled

Annullerad

Deleting

Tas bort

ProvisioningAccount

Provisioneringskonto

Updating

Uppdatera

WorkspaceFailoverProperties

Redundanstillståndet för replikeringen.

Name Typ Description
lastModifiedDate

string (date-time)

Den senaste gången som redundanstillståndet uppdaterades.

state

WorkspaceFailoverState

Redundanstillståndet för replikeringen.

WorkspaceFailoverState

Redundanstillståndet för replikeringen.

Värde Description
Inactive

Inaktiv

Activating

Aktiverar

Active

Active

Deactivating

Inaktiverar

Failed

Misslyckades

WorkspaceFeatures

Arbetsytefunktioner.

Name Typ Description
associations

string[]

Lista över associationer för arbetsytan. Anger om arbetsytan är associerad med någon av följande upplevelser: MDC, Sentinel, SentinelGraph osv.

clusterResourceId

string

Dedikerad LA-klusterresursId som är länkat till arbetsytorna.

disableLocalAuth

boolean

Inaktivera icke-AAD-baserad autentisering.

enableDataExport

boolean

Flagga som anger om data ska exporteras.

enableLogAccessUsingOnlyResourcePermissions

boolean

Flagga som anger vilken behörighet som ska användas – resurs eller arbetsyta eller både och.

immediatePurgeDataOn30Days

boolean

Flagga som beskriver om vi vill ta bort data efter 30 dagar.

unifiedSentinelBillingOnly

boolean

En indikation om den angivna arbetsytan endast är begränsad till sentinels enhetliga faktureringsmodell.

WorkspaceListResult

Åtgärdssvaret för listarbetsytorna.

Name Typ Description
nextLink

string

URL:en för att få nästa uppsättning resultat.

value

Workspace[]

En lista över arbetsytor.

WorkspaceReplicationProperties

Egenskaper för replikering av arbetsyta.

Name Typ Description
createdDate

string (date-time)

Senaste gången som replikeringen aktiverades.

enabled

boolean

Anger om replikeringen är aktiverad eller inte. När det är sant replikeras konfiguration och data för arbetsytan till den angivna platsen. Om replikering har aktiverats måste platsen anges.

lastModifiedDate

string (date-time)

Den senaste gången replikeringen uppdaterades.

location

string

Platsen för replikeringen.

provisioningState

WorkspaceReplicationState

Etableringstillståndet för replikeringen.

WorkspaceReplicationState

Etableringstillståndet för replikeringen.

Värde Description
Succeeded

lyckades

EnableRequested

AktiveraBegärd

Enabling

Aktiverar

DisableRequested

InaktiveraBegärd

Disabling

Inaktivera

RollbackRequested

RollbackBegärd

RollingBack

RollingBack

Failed

Misslyckades

Canceled

Annullerad

WorkspaceSku

SKU:n (nivån) för en arbetsyta.

Name Typ Description
capacityReservationLevel

integer (int32)

Kapacitetsreservationsnivån i GB för den här arbetsytan, när CapacityReservation sku väljs.

lastSkuUpdate

string (date-time)

Senaste gången SKU:n uppdaterades.

name

WorkspaceSkuNameEnum

Namnet på SKU:n.

WorkspaceSkuNameEnum

Namnet på SKU:n.

Värde Description
Free

Free

Standard

Standard

Premium

Premie

PerNode

Pernod

PerGB2018

PerGB2018

Standalone

Fristående

CapacityReservation

Kapacitetsreservation

LACluster

LACluster