Workspaces - List

Referenz

Dienst:: Log Analytics

API-Version:: 2023-09-01

Ruft die Arbeitsbereiche in einem Abonnement ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
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	WorkspaceListResult	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

WorkspacesSubscriptionList

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.OperationalInsights/workspaces?api-version=2023-09-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 die SKU "CapacityReservation" ausgewählt ist.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataIngestionStatus	Die status der Datenerfassung für diesen Arbeitsbereich.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource.
IdentityType	Typ der verwalteten Dienstidentität.
PrivateLinkScopedResource	Der Ressourcenverweis für den Private Link-Bereich.
PublicNetworkAccessType	Der Netzwerkzugriffstyp für den Betrieb im Log Analytics-Arbeitsbereich. Standardmäßig ist aktiviert.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserIdentityProperties	Benutzerseitig zugewiesene Identitätseigenschaften.
Workspace	Der Arbeitsbereichsressourcencontainer der obersten Ebene.
WorkspaceCapping	Die tägliche Volumenobergrenze für die Erfassung.
WorkspaceEntityStatus	Der Bereitstellungsstatus des Arbeitsbereichs.
WorkspaceFeatures	Arbeitsbereichsfeatures.
WorkspaceListResult	Die Vorgangsantwort für Listenarbeitsbereiche.
WorkspaceSku	Die SKU (Ebene) eines Arbeitsbereichs.
WorkspaceSkuNameEnum	Der Name der SKU.

CapacityReservationLevel

Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn die SKU "CapacityReservation" ausgewählt ist.

Name	Typ	Beschreibung
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

Die status der Datenerfassung für diesen Arbeitsbereich.

Name	Typ	Beschreibung
ApproachingQuota	string	80 % des täglichen Cap-Kontingents erreicht.
ForceOff	string	Die Erfassung wurde nach änderung der Diensteinstellung beendet.
ForceOn	string	Die Erfassung wurde nach änderung der Diensteinstellung gestartet.
OverQuota	string	Tägliches Obergrenzeskontingent erreicht, Erfassung beendet.
RespectQuota	string	Die Erfassung wird nach der täglichen Kontingentzurücksetzung oder der Abonnementaktivierung aktiviert.
SubscriptionSuspended	string	Die Erfassung wurde nach dem angehaltenen Abonnement beendet.

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.

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 Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Typ der verwalteten Dienstidentität.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

Der Ressourcenverweis für den Private Link-Bereich.

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 Betrieb im Log Analytics-Arbeitsbereich. Standardmäßig ist aktiviert.

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

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.

UserIdentityProperties

Benutzerseitig 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 Arbeitsbereichsressourcencontainer der obersten Ebene.

Name	Typ	Standardwert	Beschreibung
etag	string		Das etag des Arbeitsbereichs.
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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		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.features	WorkspaceFeatures		Arbeitsbereichsfeatures.
properties.forceCmkForQuery	boolean		Gibt an, ob der vom Kunden verwaltete Speicher für die Abfrageverwaltung obligatorisch ist.
properties.modifiedDate	string		Ä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 die Log Analytics-Erfassung.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Der Netzwerkzugriffstyp für den Zugriff auf die Log Analytics-Abfrage.
properties.retentionInDays	integer		Die Datenaufbewahrung des Arbeitsbereichs in Tagen. Zulässige Werte sind pro Preisplan. Weitere Informationen finden Sie in der Dokumentation zu Tarifen.
properties.sku	WorkspaceSku		Die SKU des Arbeitsbereichs.
properties.workspaceCapping	WorkspaceCapping		Die tägliche Volumenobergrenze für die Erfassung.
systemData	systemData		Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Die tägliche Volumenobergrenze für die Erfassung.

Name	Typ	Beschreibung
dailyQuotaGb	number	Das tägliche Kontingent des Arbeitsbereichs für die Erfassung.
dataIngestionStatus	DataIngestionStatus	Die status der Datenerfassung für diesen Arbeitsbereich.
quotaNextResetTime	string	Der Zeitpunkt, zu dem das Kontingent ruhen wird.

WorkspaceEntityStatus

Der Bereitstellungsstatus des Arbeitsbereichs.

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

Arbeitsbereichsfeatures.

Name	Typ	Beschreibung
clusterResourceId	string	ResourceId für dedizierte LA-Cluster, die mit den Arbeitsbereichen verknüpft ist.
disableLocalAuth	boolean	Deaktivieren Sie die 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	Flag, 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

Die Vorgangsantwort für Listenarbeitsbereiche.

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

WorkspaceSku

Die SKU (Ebene) eines Arbeitsbereichs.

Name	Typ	Beschreibung
capacityReservationLevel	CapacityReservationLevel	Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn die SKU "CapacityReservation" ausgewählt ist.
lastSkuUpdate	string	Das letzte Mal, zu dem die SKU aktualisiert wurde.
name	WorkspaceSkuNameEnum	Der Name der SKU.

WorkspaceSkuNameEnum

Der Name der SKU.

Name	Typ	Beschreibung
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string

Freigeben über