Workspaces - Get

Usługa:

Log Analytics

Wersja interfejsu API:

2026-03-01

Pobiera wystąpienie obszaru roboczego.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nazwa obszaru roboczego.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Workspace	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	podszywaj się pod konto użytkownika

Przykłady

WorkspaceGet

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "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"
    }
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
DataIngestionStatus	Stan pozyskiwania danych dla tego obszaru roboczego.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Identity	Tożsamość zasobu.
IdentityType	Typ tożsamości usługi zarządzanej.
PrivateLinkScopedResource	Odwołanie do zasobu zakresu łącza prywatnego.
PublicNetworkAccessType	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do pozyskiwania usługi Log Analytics.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserIdentityProperties	Właściwości tożsamości przypisanej przez użytkownika.
Workspace	Kontener zasobów obszaru roboczego najwyższego poziomu.
WorkspaceCapping	Dzienny limit ilości na potrzeby pozyskiwania.
WorkspaceEntityStatus	Stan aprowizacji obszaru roboczego.
WorkspaceFailoverProperties	Stan pracy awaryjnej replikacji.
WorkspaceFailoverState	Stan pracy awaryjnej replikacji.
WorkspaceFeatures	Funkcje obszaru roboczego.
WorkspaceReplicationProperties	Właściwości replikacji obszaru roboczego.
WorkspaceReplicationState	Stan aprowizacji replikacji.
WorkspaceSku	Jednostka SKU (warstwa) obszaru roboczego.
WorkspaceSkuNameEnum	Nazwa jednostki SKU.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DataIngestionStatus

Wyliczenie

Stan pozyskiwania danych dla tego obszaru roboczego.

Wartość	Opis
RespectQuota	Pozyskiwanie jest włączone po zresetowaniu dziennego limitu przydziału lub włączeniu subskrypcji.
ForceOn	Pozyskiwanie rozpoczęto po zmianie ustawienia usługi.
ForceOff	Pozyskiwanie zatrzymało się po zmianie ustawienia usługi.
OverQuota	Osiągnięto dzienny limit przydziału, pozyskiwanie zatrzymano.
SubscriptionSuspended	Pozyskiwanie zostało zatrzymane po zawieszonej subskrypcji.
ApproachingQuota	Osiągnięto 80% dziennego limitu przydziału.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Identity

Objekt

Tożsamość zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości zasobu.
tenantId	string	Identyfikator dzierżawy zasobu.
type	IdentityType	Typ tożsamości usługi zarządzanej.
userAssignedIdentities	<string,  UserIdentityProperties>	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Wyliczenie

Typ tożsamości usługi zarządzanej.

Wartość	Opis
SystemAssigned	SystemAssigned
UserAssigned	UserAssigned
None	None

PrivateLinkScopedResource

Objekt

Odwołanie do zasobu zakresu łącza prywatnego.

Nazwa	Typ	Opis
resourceId	string	Pełny identyfikator zasobu zakresu łącza prywatnego.
scopeId	string	Unikatowy identyfikator zakresu łącza prywatnego.

PublicNetworkAccessType

Wyliczenie

Typ dostępu do sieci na potrzeby uzyskiwania dostępu do pozyskiwania usługi Log Analytics.

Wartość	Opis
Enabled	Umożliwia łączność z usługą Log Analytics za pośrednictwem publicznego systemu DNS.
Disabled	Wyłącza łączność publiczną z usługą Log Analytics za pośrednictwem publicznego systemu DNS.
SecuredByPerimeter	Zasób jest dostępny tylko z sieci prywatnych i dostępu zatwierdzonego przez obwód zabezpieczeń sieci skojarzony z tym zasobem.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserIdentityProperties

Objekt

Właściwości tożsamości przypisanej przez użytkownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika.
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

Workspace

Objekt

Kontener zasobów obszaru roboczego najwyższego poziomu.

Nazwa	Typ	Domyślna wartość	Opis
etag	string		Element etag obszaru roboczego.
id	string (arm-id)		W pełni określony identyfikator zasobu dla tego zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		Tożsamość zasobu.
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.createdDate	string (date-time)		Data utworzenia obszaru roboczego.
properties.customerId	string		Jest to właściwość tylko do odczytu. Reprezentuje identyfikator skojarzony z obszarem roboczym.
properties.defaultDataCollectionRuleResourceId	string		Identyfikator zasobu domyślnej reguły zbierania danych do użycia w tym obszarze roboczym. Oczekiwany format to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover	WorkspaceFailoverProperties		właściwości trybu failover obszaru roboczego.
properties.features	WorkspaceFeatures		Funkcje obszaru roboczego.
properties.forceCmkForQuery	boolean		Wskazuje, czy magazyn zarządzany przez klienta jest obowiązkowy do zarządzania zapytaniami.
properties.modifiedDate	string (date-time)		Data modyfikacji obszaru roboczego.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lista połączonych zasobów zakresu łącza prywatnego.
properties.provisioningState	WorkspaceEntityStatus		Stan aprowizacji obszaru roboczego.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do pozyskiwania usługi Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Typ dostępu do sieci na potrzeby uzyskiwania dostępu do zapytania usługi Log Analytics.
properties.replication	WorkspaceReplicationProperties		właściwości replikacji obszaru roboczego.
properties.retentionInDays	integer (int32)		Okres przechowywania danych obszaru roboczego w dniach. Dozwolone wartości są według planu cenowego. Aby uzyskać szczegółowe informacje, zobacz dokumentację warstw cenowych.
properties.sku	WorkspaceSku		Jednostka SKU obszaru roboczego.
properties.workspaceCapping	WorkspaceCapping		Dzienny limit ilości na potrzeby pozyskiwania.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Objekt

Dzienny limit ilości na potrzeby pozyskiwania.

Nazwa	Typ	Opis
dailyQuotaGb	number (double)	Dzienny limit przydziału obszaru roboczego na potrzeby pozyskiwania.
dataIngestionStatus	DataIngestionStatus	Stan pozyskiwania danych dla tego obszaru roboczego.
quotaNextResetTime	string	Czas odpoczynku przydziału.

WorkspaceEntityStatus

Wyliczenie

Stan aprowizacji obszaru roboczego.

Wartość	Opis
Creating	Tworzenie
Succeeded	Succeeded
Failed	Failed
Canceled	Anulowane
Deleting	Usuwanie
ProvisioningAccount	Aprowizowanie konta
Updating	Aktualizowanie

WorkspaceFailoverProperties

Objekt

Stan pracy awaryjnej replikacji.

Nazwa	Typ	Opis
lastModifiedDate	string (date-time)	Ostatni czas aktualizacji stanu trybu failover.
state	WorkspaceFailoverState	Stan pracy awaryjnej replikacji.

WorkspaceFailoverState

Wyliczenie

Stan pracy awaryjnej replikacji.

Wartość	Opis
Inactive	Nieaktywny
Activating	Aktywowanie
Active	Aktywne
Deactivating	Dezaktywowanie
Failed	Failed

WorkspaceFeatures

Objekt

Funkcje obszaru roboczego.

Nazwa	Typ	Opis
associations	string[]	Lista powiązań dla obszaru roboczego. Wskazuje, czy obszar roboczy jest skojarzony z którymkolwiek z następujących środowisk: MDC, Sentinel, SentinelGraph itp.
clusterResourceId	string	Dedykowany identyfikator resourceId klastra la połączony z obszarami roboczymi.
dataAuthorizationMode	boolean	Włącz tryb autoryzacji danych dla przestrzeni roboczej.
disableLocalAuth	boolean	Wyłącz uwierzytelnianie oparte na usłudze AAD.
enableDataExport	boolean	Flaga wskazująca, czy dane mają być eksportowane.
enableLogAccessUsingOnlyResourcePermissions	boolean	Flaga wskazująca, które uprawnienie do użycia — zasób lub obszar roboczy lub oba te elementy.
immediatePurgeDataOn30Days	boolean	Flaga opisując, czy chcemy usunąć dane po 30 dniach.
unifiedSentinelBillingOnly	boolean	Wskazanie, czy określony obszar roboczy jest ograniczony tylko do ujednoliconego modelu rozliczeń usługi Sentinel.

WorkspaceReplicationProperties

Objekt

Właściwości replikacji obszaru roboczego.

Nazwa	Typ	Opis
createdDate	string (date-time)	Ostatni raz, kiedy replikacja była włączona.
enabled	boolean	Określa, czy replikacja jest włączona, czy nie. W przypadku wartości true konfiguracja i dane obszaru roboczego są replikowane do określonej lokalizacji. Jeśli włączono replikację, należy podać lokalizację.
lastModifiedDate	string (date-time)	Ostatni czas aktualizacji replikacji.
location	string	Lokalizacja replikacji.
provisioningState	WorkspaceReplicationState	Stan aprowizacji replikacji.

WorkspaceReplicationState

Wyliczenie

Stan aprowizacji replikacji.

Wartość	Opis
Succeeded	Succeeded
EnableRequested	EnableRequested
Enabling	Włączanie
DisableRequested	DisableRequested
Disabling	Wyłączanie
RollbackRequested	RollbackRequests
RollingBack	RollingBack
Failed	Failed
Canceled	Anulowane

WorkspaceSku

Objekt

Jednostka SKU (warstwa) obszaru roboczego.

Nazwa	Typ	Opis
capacityReservationLevel	integer (int32)	Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.
lastSkuUpdate	string (date-time)	Czas ostatniej aktualizacji jednostki SKU.
name	WorkspaceSkuNameEnum	Nazwa jednostki SKU.

WorkspaceSkuNameEnum

Wyliczenie

Nazwa jednostki SKU.

Wartość	Opis
Free	Bezpłatna
Standard	Standard
Premium	Premium
PerNode	PerNode
PerGB2018	PerGB2018
Standalone	Samodzielny
CapacityReservation	CapacityReservation
LACluster	LACluster