Workspaces - List

Odwołanie

Service:: Log Analytics

API Version:: 2023-09-01

Pobiera obszary robocze w subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkspaceListResult	Definicja odpowiedzi OK.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

WorkspacesSubscriptionList

Sample Request

HTTP

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

Sample Response

Status code:: 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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
CapacityReservationLevel	Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.
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 dla działania w obszarze roboczym usługi Log Analytics. Domyślnie jest włączona
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.
WorkspaceFeatures	Funkcje obszaru roboczego.
WorkspaceListResult	Odpowiedź operacji obszarów roboczych listy.
WorkspaceSku	Jednostka SKU (warstwa) obszaru roboczego.
WorkspaceSkuNameEnum	Nazwa jednostki SKU.

CapacityReservationLevel

Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.

Nazwa	Typ	Opis
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

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

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

Stan pozyskiwania danych dla tego obszaru roboczego.

Nazwa	Typ	Opis
ApproachingQuota	string	80% dziennego limitu przydziału osiągnięto.
ForceOff	string	Pozyskiwanie zatrzymało się po zmianie ustawienia usługi.
ForceOn	string	Pozyskiwanie zaczęło się po zmianie ustawienia usługi.
OverQuota	string	Osiągnięto dzienny limit przydziału limitu, pozyskiwanie zatrzymano.
RespectQuota	string	Pozyskiwanie jest włączone po zresetowaniu dziennego limitu przydziału lub włączeniu subskrypcji.
SubscriptionSuspended	string	Pozyskiwanie zostało zatrzymane po wstrzymanej subskrypcji.

ErrorAdditionalInfo

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

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

ErrorDetail

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	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Identity

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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

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

Nazwa	Typ	Opis
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

Odwołanie do zasobu zakresu łącza prywatnego.

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

PublicNetworkAccessType

Typ dostępu do sieci dla działania w obszarze roboczym usługi Log Analytics. Domyślnie jest włączona

Nazwa	Typ	Opis
Disabled	string	Wyłącza łączność publiczną z usługą Log Analytics za pośrednictwem publicznego systemu DNS.
Enabled	string	Umożliwia łączność z usługą Log Analytics za pośrednictwem publicznego systemu DNS.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	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	Sygnatura czasowa 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

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

Kontener zasobów obszaru roboczego najwyższego poziomu.

Nazwa	Typ	Wartość domyślna	Opis
etag	string		Element etag obszaru roboczego.
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /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		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 dla tego obszaru roboczego. Oczekiwany format to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
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		Data modyfikacji obszaru roboczego.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lista połączonych zasobów zakresu linków prywatnych.
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.retentionInDays	integer		Przechowywanie 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 dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Dzienny limit ilości na potrzeby pozyskiwania.

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

WorkspaceEntityStatus

Stan aprowizacji obszaru roboczego.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

Funkcje obszaru roboczego.

Nazwa	Typ	Opis
clusterResourceId	string	Dedykowany identyfikator zasobu klastra LA połączony z obszarami roboczymi.
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 uprawnienia do użycia — zasób lub obszar roboczy lub oba te elementy.
immediatePurgeDataOn30Days	boolean	Flaga, która opisuje, czy chcemy usunąć dane po upływie 30 dni.
unifiedSentinelBillingOnly	boolean	Wskazanie, czy określony obszar roboczy jest ograniczony tylko do ujednoliconego modelu rozliczeniowego usługi Sentinel.

WorkspaceListResult

Odpowiedź operacji obszarów roboczych listy.

Nazwa	Typ	Opis
value	Workspace[]	Lista obszarów roboczych.

WorkspaceSku

Jednostka SKU (warstwa) obszaru roboczego.

Nazwa	Typ	Opis
capacityReservationLevel	CapacityReservationLevel	Poziom rezerwacji pojemności w GB dla tego obszaru roboczego po wybraniu jednostki SKU CapacityReservation.
lastSkuUpdate	string	Czas ostatniej aktualizacji jednostki SKU.
name	WorkspaceSkuNameEnum	Nazwa jednostki SKU.

WorkspaceSkuNameEnum

Nazwa jednostki SKU.

Nazwa	Typ	Opis
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string