Workspaces - Get

Referenz

Dienst:: Log Analytics

API-Version:: 2023-09-01

Ruft einen Arbeitsbereich instance ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Den Namen 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	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

WorkspaceGet

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685?api-version=2023-09-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": {
    "customerId": "5b02755b-5bf4-430c-9487-45502a2a7e62",
    "provisioningState": "Succeeded",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/oiautorest6685",
  "name": "oiautorest6685",
  "type": "Microsoft.OperationalInsights/workspaces",
  "location": "eastus"
}

Definitionen

Name	Beschreibung
CapacityReservationLevel	Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn Die CapacityReservation-SKU 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 Ressourcencontainer der obersten Ebene des Arbeitsbereichs.
WorkspaceCapping	Die tägliche Volumenobergrenze für die Erfassung.
WorkspaceEntityStatus	Der Bereitstellungsstatus des Arbeitsbereichs.
WorkspaceFeatures	Arbeitsbereichsfeatures.
WorkspaceSku	Die SKU (Ebene) eines Arbeitsbereichs.
WorkspaceSkuNameEnum	Der Name der SKU.

CapacityReservationLevel

Enumeration

Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn Die 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

Die status der Datenerfassung für diesen Arbeitsbereich.

Wert	Beschreibung
ApproachingQuota	80 % der täglichen Obergrenze erreicht.
ForceOff	Die Erfassung wurde nach der Änderung der Diensteinstellung beendet.
ForceOn	Die Erfassung wurde nach der Änderung der Diensteinstellung gestartet.
OverQuota	Tägliches Cap-Kontingent erreicht, Erfassung beendet.
RespectQuota	Die Erfassung wird nach der täglichen Zurücksetzung des Obergrenzenkontingents oder der Abonnementaktivierung aktiviert.
SubscriptionSuspended	Die Erfassung wurde nach dem angehaltenen Abonnement beendet.

ErrorAdditionalInfo

Objekt

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Objekt

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

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. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{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 Private Link-Bereich.

Name	Typ	Beschreibung
resourceId	string	Die vollständige Ressourcen-ID der Private Link-Bereichsressource.
scopeId	string	Der eindeutige Bezeichner des Privaten Linkbereichs.

PublicNetworkAccessType

Enumeration

Der Netzwerkzugriffstyp für den Betrieb im Log Analytics-Arbeitsbereich. Standardmäßig ist 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, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

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

Benutzerseitig zugewiesene Identitätseigenschaften.

Name	Typ	Beschreibung
clientId	string	Die Client-ID der benutzerseitig zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der benutzerseitig 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. 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 Ressourcen des Bereichs für verknüpfte private Links.
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 (int32)		Die Datenaufbewahrung des Arbeitsbereichs in Tagen. Zulässige Werte sind pro Preisplan. Weitere Informationen finden Sie in der Dokumentation zu Preistarifen.
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

Objekt

Die tägliche Volumenobergrenze für die Erfassung.

Name	Typ	Beschreibung
dailyQuotaGb	number (double)	Das tägliche Arbeitsbereichskontingent 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

Enumeration

Der Bereitstellungsstatus des Arbeitsbereichs.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

WorkspaceFeatures

Objekt

Arbeitsbereichsfeatures.

Name	Typ	Beschreibung
clusterResourceId	string	Dedizierte LA-Clusterressourcenid, 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, ob der angegebene Arbeitsbereich nur auf das einheitliche Abrechnungsmodell von Sentinel beschränkt ist.

WorkspaceSku

Objekt

Die SKU (Ebene) eines Arbeitsbereichs.

Name	Typ	Beschreibung
capacityReservationLevel	CapacityReservationLevel (int32)	Die Kapazitätsreservierungsebene in GB für diesen Arbeitsbereich, wenn Die CapacityReservation-SKU ausgewählt ist.
lastSkuUpdate	string	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 - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

WorkspaceGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFeatures

WorkspaceSku

WorkspaceSkuNameEnum

Zusätzliche Ressourcen