Workspaces - Get

Ruft eine Arbeitsbereichsinstanz ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string (uuid)

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

workspaceName
path True

string

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

Der Name des Arbeitsbereichs.

api-version
query True

string

minLength: 1

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

Antworten

Name Typ Beschreibung
200 OK

Workspace

Der Azure-Vorgang wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

WorkspaceGet

Beispielanforderung

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

Beispiel für eine Antwort

{
  "name": "oiautorest6685",
  "type": "Microsoft.OperationalInsights/workspaces",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/oiautorest6685",
  "location": "eastus",
  "properties": {
    "customerId": "5b02755b-5bf4-430c-9487-45502a2a7e62",
    "failover": {
      "lastModifiedDate": "2020-07-05T07:35:51Z",
      "state": "Active"
    },
    "provisioningState": "Succeeded",
    "publicNetworkAccessForIngestion": "Enabled",
    "publicNetworkAccessForQuery": "Enabled",
    "replication": {
      "createdDate": "2020-07-04T07:35:51Z",
      "enabled": true,
      "lastModifiedDate": "2020-07-04T07:35:51Z",
      "location": "westus3",
      "provisioningState": "Succeeded"
    },
    "retentionInDays": 30,
    "sku": {
      "name": "PerGB2018"
    }
  }
}

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DataIngestionStatus

Der Status der Datenerfassung für diesen Arbeitsbereich.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

Identity

Identität für die Ressource.

IdentityType

Typ der verwalteten Dienstidentität.

PrivateLinkScopedResource

Der Ressourcenverweis für den privaten Linkbereich.

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Zugriff auf log Analytics-Erfassung.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

UserIdentityProperties

Vom Benutzer zugewiesene Identitätseigenschaften.

Workspace

Der Workspace-Ressourcencontainer auf oberster Ebene.

WorkspaceCapping

Die tägliche Volumengrenze für die Aufnahme.

WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.

WorkspaceFailoverProperties

Der Failoverstatus der Replikation.

WorkspaceFailoverState

Der Failoverstatus der Replikation.

WorkspaceFeatures

Arbeitsbereichsfeatures.

WorkspaceReplicationProperties

Eigenschaften der Arbeitsbereichsreplikation.

WorkspaceReplicationState

Der Bereitstellungsstatus der Replizierung.

WorkspaceSku

Die SKU (Ebene) eines Arbeitsbereichs.

WorkspaceSkuNameEnum

Der Name der SKU.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

DataIngestionStatus

Der Status der Datenerfassung für diesen Arbeitsbereich.

Wert Beschreibung
RespectQuota

Die Aufnahme wird nach dem Zurücksetzen des täglichen Cap-Kontingents oder der Aktivierung des Abonnements aktiviert.

ForceOn

Die Erfassung wurde nach einer Änderung der Diensteinstellungen gestartet.

ForceOff

Die Erfassung wurde nach einer Änderung der Diensteinstellungen gestoppt.

OverQuota

Das Kontingent für die tägliche Obergrenze wurde erreicht, die Erfassung wurde gestoppt.

SubscriptionSuspended

Die Erfassung wurde nach dem Anhalten des Abonnements beendet.

ApproachingQuota

80% der täglichen Obergrenze erreicht.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

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.

Identity

Identität für die Ressource.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Ressourcenidentität.

tenantId

string

Die Mandanten-ID der Ressource.

type

IdentityType

Typ der verwalteten Dienstidentität.

userAssignedIdentities

<string,  UserIdentityProperties>

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Typ der verwalteten Dienstidentität.

Wert Beschreibung
SystemAssigned

SystemAssigned

UserAssigned

UserAssigned

None

Nichts

PrivateLinkScopedResource

Der Ressourcenverweis für den privaten Linkbereich.

Name Typ Beschreibung
resourceId

string

Die vollständige Ressourcen-ID der Private Link-Bereichsressource.

scopeId

string

Der eindeutige Bezeichner des Private Link-Bereichs.

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Zugriff auf log Analytics-Erfassung.

Wert Beschreibung
Enabled

Ermöglicht die Konnektivität mit Log Analytics über öffentliches DNS.

Disabled

Deaktiviert die öffentliche Konnektivität mit Log Analytics über öffentliches DNS.

SecuredByPerimeter

Der Zugriff auf die Ressource ist nur über private Netzwerke und der Zugriff vom Netzwerksicherheitsbereich genehmigt, der dieser Ressource zugeordnet ist.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

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 (date-time)

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.

UserIdentityProperties

Vom Benutzer zugewiesene Identitätseigenschaften.

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.

principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

Workspace

Der Workspace-Ressourcencontainer auf oberster Ebene.

Name Typ Standardwert Beschreibung
etag

string

Das Etag des Arbeitsbereichs.

id

string (arm-id)

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

identity

Identity

Die Identität der Ressource.

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.createdDate

string (date-time)

Erstellungsdatum des Arbeitsbereichs.

properties.customerId

string

Dies ist eine schreibgeschützte Eigenschaft. Stellt die ID dar, die dem Arbeitsbereich zugeordnet ist.

properties.defaultDataCollectionRuleResourceId

string

Die Ressourcen-ID der Standarddatensammlungsregel, die für diesen Arbeitsbereich verwendet werden soll. Das erwartete Format lautet : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.

properties.failover

WorkspaceFailoverProperties

Arbeitsbereichfailovereigenschaften.

properties.features

WorkspaceFeatures

Arbeitsbereichsfeatures.

properties.forceCmkForQuery

boolean

Gibt an, ob der vom Kunden verwaltete Speicher für die Abfrageverwaltung obligatorisch ist.

properties.modifiedDate

string (date-time)

Änderungsdatum des Arbeitsbereichs.

properties.privateLinkScopedResources

PrivateLinkScopedResource[]

Liste der verknüpften Private Link-Bereichsressourcen.

properties.provisioningState

WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.

properties.publicNetworkAccessForIngestion

PublicNetworkAccessType

Enabled

Der Netzwerkzugriffstyp für den Zugriff auf log Analytics-Erfassung.

properties.publicNetworkAccessForQuery

PublicNetworkAccessType

Enabled

Der Netzwerkzugriffstyp für den Zugriff auf log Analytics-Abfrage.

properties.replication

WorkspaceReplicationProperties

Arbeitsbereichreplikationseigenschaften.

properties.retentionInDays

integer (int32)

Die Aufbewahrung von Arbeitsbereichsdaten in Tagen. Zulässige Werte sind pro Preisplan. Ausführliche Informationen finden Sie in der Dokumentation zum Tarif.

properties.sku

WorkspaceSku

Die SKU des Arbeitsbereichs.

properties.workspaceCapping

WorkspaceCapping

Die tägliche Volumengrenze für die Aufnahme.

systemData

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.

tags

object

Ressourcentags.

type

string

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

WorkspaceCapping

Die tägliche Volumengrenze für die Aufnahme.

Name Typ Beschreibung
dailyQuotaGb

number (double)

Das tägliche Arbeitsbereichskontingent für die Aufnahme.

dataIngestionStatus

DataIngestionStatus

Der Status der Datenerfassung für diesen Arbeitsbereich.

quotaNextResetTime

string

Der Zeitpunkt, zu dem das Kontingent Ruhezeit sein wird.

WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.

Wert Beschreibung
Creating

Erstellen

Succeeded

Erfolgreich

Failed

gescheitert

Canceled

Abgesagt

Deleting

Löschen

ProvisioningAccount

ProvisioningAccount

Updating

Wird aktualisiert

WorkspaceFailoverProperties

Der Failoverstatus der Replikation.

Name Typ Beschreibung
lastModifiedDate

string (date-time)

Das letzte Mal, als der Failoverstatus aktualisiert wurde.

state

WorkspaceFailoverState

Der Failoverstatus der Replikation.

WorkspaceFailoverState

Der Failoverstatus der Replikation.

Wert Beschreibung
Inactive

Inaktiv

Activating

Aktivierend

Active

Active

Deactivating

Wird deaktiviert

Failed

gescheitert

WorkspaceFeatures

Arbeitsbereichsfeatures.

Name Typ Beschreibung
associations

string[]

Liste der Zuordnungen für den Arbeitsbereich. Gibt an, ob der Arbeitsbereich mit einer der folgenden Erfahrungen verknüpft ist: MDC, Sentinel, SentinelGraph usw.

clusterResourceId

string

Dedizierte LA-Clusterressourcen-ID, die mit den Arbeitsbereichen verknüpft ist.

disableLocalAuth

boolean

Deaktivieren Sie nicht AAD-basierte Authentifizierung.

enableDataExport

boolean

Flag, das angibt, ob Daten exportiert werden sollen.

enableLogAccessUsingOnlyResourcePermissions

boolean

Flag, das angibt, welche Berechtigung verwendet werden soll – Ressource oder Arbeitsbereich oder beides.

immediatePurgeDataOn30Days

boolean

Kennzeichnen, das beschreibt, ob die Daten nach 30 Tagen entfernt werden sollen.

unifiedSentinelBillingOnly

boolean

Ein Angabe, ob der angegebene Arbeitsbereich nur auf das einheitliche Abrechnungsmodell von Sentinel beschränkt ist.

WorkspaceReplicationProperties

Eigenschaften der Arbeitsbereichsreplikation.

Name Typ Beschreibung
createdDate

string (date-time)

Der Zeitpunkt, zu dem die Replizierung das letzte Mal aktiviert wurde.

enabled

boolean

Gibt an, ob die Replikation aktiviert ist oder nicht. Wenn "true", wird die Arbeitsbereichskonfiguration und -daten an den angegebenen Speicherort repliziert. Wenn die Replikation aktiviert ist, muss der Standort angegeben werden.

lastModifiedDate

string (date-time)

Der Zeitpunkt, zu dem die Replizierung das letzte Mal aktualisiert wurde.

location

string

Der Speicherort der Replikation.

provisioningState

WorkspaceReplicationState

Der Bereitstellungsstatus der Replizierung.

WorkspaceReplicationState

Der Bereitstellungsstatus der Replizierung.

Wert Beschreibung
Succeeded

Erfolgreich

EnableRequested

AktivierenAngefragt

Enabling

Wird aktiviert

DisableRequested

DeaktivierenAngefragt

Disabling

Deaktivieren

RollbackRequested

RollbackAngefragt

RollingBack

RollingBack

Failed

gescheitert

Canceled

Abgesagt

WorkspaceSku

Die SKU (Ebene) eines Arbeitsbereichs.

Name Typ Beschreibung
capacityReservationLevel

integer (int32)

Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn capacityReservation sku ausgewählt ist.

lastSkuUpdate

string (date-time)

Das letzte Mal, als die SKU aktualisiert wurde.

name

WorkspaceSkuNameEnum

Der Name der SKU.

WorkspaceSkuNameEnum

Der Name der SKU.

Wert Beschreibung
Free

Free

Standard

Standard

Premium

Premium

PerNode

PerNode

PerGB2018

PerGB2018

Standalone

Eigenständig

CapacityReservation

CapacityReservation

LACluster

LACluster