Workspaces - List

Referenz

Dienst:: Log Analytics

API-Version:: 2025-02-01

Ruft die Arbeitsbereiche in einem Abonnement ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	WorkspaceListResult	OK-Antwortdefinition.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

WorkspacesSubscriptionList

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
CapacityReservationLevel	Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn capacityReservation sku ausgewählt ist.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataIngestionStatus	Der Status der Datenaufnahme 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 die Verwendung im Log Analytics-Arbeitsbereich. Standardmäßig ist sie aktiviert.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserIdentityProperties	Vom Benutzer zugewiesene Identitätseigenschaften.
Workspace	Der Ressourcencontainer der obersten Ebene des Arbeitsbereichs.
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.
WorkspaceListResult	Die Antwort des Listenarbeitsbereichsvorgangs.
WorkspaceReplicationProperties	Arbeitsbereichreplikationseigenschaften.
WorkspaceReplicationState	Der Bereitstellungsstatus der Replikation.
WorkspaceSku	Die SKU (Ebene) eines Arbeitsbereichs.
WorkspaceSkuNameEnum	Der Name der SKU.

CapacityReservationLevel

Enumeration

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

Wert	Beschreibung
100
1000
10000
200
2000
25000
300
400
500
5000
50000

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DataIngestionStatus

Enumeration

Der Status der Datenaufnahme für diesen Arbeitsbereich.

Wert	Beschreibung
ApproachingQuota	80% des tageshöchsten Kontingents erreicht.
ForceOff	Die Aufnahme wurde nach der Änderung der Diensteinstellung beendet.
ForceOn	Die Aufnahme hat mit der Änderung der Diensteinstellung begonnen.
OverQuota	Das tageshöchste Kontingent wurde erreicht, die Aufnahme wurde beendet.
RespectQuota	Die Aufnahme wurde nach dem Zurücksetzen des Tageskontingents oder der Abonnementaktivierung aktiviert.
SubscriptionSuspended	Die Aufnahme wurde nach dem angehaltenen Abonnement beendet.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

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

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Identity

Objekt

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

Enumeration

Typ der verwalteten Dienstidentität.

Wert	Beschreibung
None
SystemAssigned
UserAssigned

PrivateLinkScopedResource

Objekt

Der Ressourcenverweis für den privaten Linkbereich.

Name	Typ	Beschreibung
resourceId	string	Die vollständige Ressourcen-ID der Ressource für den privaten Linkbereich.
scopeId	string	Der eindeutige Bezeichner des privaten Verknüpfungsbereichs.

PublicNetworkAccessType

Enumeration

Der Netzwerkzugriffstyp für die Verwendung im Log Analytics-Arbeitsbereich. Standardmäßig ist sie aktiviert.

Wert	Beschreibung
Disabled	Deaktiviert die öffentliche Konnektivität mit Log Analytics über öffentliches DNS.
Enabled	Ermöglicht die Konnektivität mit Log Analytics über öffentliches DNS.

systemData

Objekt

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

Objekt

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

Objekt

Der Ressourcencontainer der obersten Ebene des Arbeitsbereichs.

Name	Typ	Standardwert	Beschreibung
etag	string		Das Etag des Arbeitsbereichs.
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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 Ressourcen für den Privaten Linkbereich.
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 zu Preisniveaus.
properties.sku	WorkspaceSku		Die SKU des Arbeitsbereichs.
properties.workspaceCapping	WorkspaceCapping		Die tägliche Volumengrenze für die Aufnahme.
systemData	systemData		Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Objekt

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 Datenaufnahme für diesen Arbeitsbereich.
quotaNextResetTime	string	Der Zeitpunkt, zu dem das Kontingent ruhet.

WorkspaceEntityStatus

Enumeration

Der Bereitstellungsstatus des Arbeitsbereichs.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFailoverProperties

Objekt

Der Failoverstatus der Replikation.

Name	Typ	Beschreibung
lastModifiedDate	string (date-time)	Das letzte Mal, zu dem der Failoverstatus aktualisiert wurde.
state	WorkspaceFailoverState	Der Failoverstatus der Replikation.

WorkspaceFailoverState

Enumeration

Der Failoverstatus der Replikation.

Wert	Beschreibung
Activating
Active
Deactivating
Failed
Inactive

WorkspaceFeatures

Objekt

Arbeitsbereichsfeatures.

Name	Typ	Beschreibung
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 Hinweis, wenn der angegebene Arbeitsbereich nur auf das einheitliche Abrechnungsmodell von Sentinel beschränkt ist.

WorkspaceListResult

Objekt

Die Antwort des Listenarbeitsbereichsvorgangs.

Name	Typ	Beschreibung
value	Workspace[]	Eine Liste der Arbeitsbereiche.

WorkspaceReplicationProperties

Objekt

Arbeitsbereichreplikationseigenschaften.

Name	Typ	Beschreibung
createdDate	string (date-time)	Das letzte Mal, als die Replikation 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)	Zeitpunkt der letzten Aktualisierung der Replikation.
location	string	Der Speicherort der Replikation.
provisioningState	WorkspaceReplicationState	Der Bereitstellungsstatus der Replikation.

WorkspaceReplicationState

Enumeration

Der Bereitstellungsstatus der Replikation.

Wert	Beschreibung
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

WorkspaceSku

Objekt

Die SKU (Ebene) eines Arbeitsbereichs.

Name	Typ	Beschreibung
capacityReservationLevel	CapacityReservationLevel (int32)	Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn capacityReservation sku ausgewählt ist.
lastSkuUpdate	string (date-time)	Das letzte Mal, zu dem die SKU aktualisiert wurde.
name	WorkspaceSkuNameEnum	Der Name der SKU.

WorkspaceSkuNameEnum

Enumeration

Der Name der SKU.

Wert	Beschreibung
CapacityReservation
Free
LACluster
PerGB2018
PerNode
Premium
Standalone
Standard

Freigeben über

Workspaces - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

WorkspacesSubscriptionList

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceListResult

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum

Zusätzliche Ressourcen