Workspaces - List

Služba:

Log Analytics

Verze rozhraní API:

2023-09-01

Získá pracovní prostory v předplatném.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	WorkspaceListResult	Definice odpovědi OK.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

WorkspacesSubscriptionList

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CapacityReservationLevel	Úroveň rezervace kapacity v GB pro tento pracovní prostor, když je vybraná sku CapacityReservation.
createdByType	Typ identity, která vytvořila prostředek.
DataIngestionStatus	Stav příjmu dat pro tento pracovní prostor.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
Identity	Identita prostředku.
IdentityType	Typ identity spravované služby
PrivateLinkScopedResource	Referenční informace k prostředku oboru privátního propojení
PublicNetworkAccessType	Typ síťového přístupu pro provoz v pracovním prostoru služby Log Analytics. Ve výchozím nastavení je povoleno.
systemData	Metadata týkající se vytvoření a poslední změny prostředku
UserIdentityProperties	Vlastnosti identity přiřazené uživatelem.
Workspace	Kontejner prostředků pracovního prostoru nejvyšší úrovně.
WorkspaceCapping	Denní limit objemu pro příjem dat.
WorkspaceEntityStatus	Stav zřizování pracovního prostoru.
WorkspaceFeatures	Funkce pracovního prostoru.
WorkspaceListResult	Odpověď operace pracovních prostorů seznamu
WorkspaceSku	Skladová položka (úroveň) pracovního prostoru.
WorkspaceSkuNameEnum	Název skladové položky.

CapacityReservationLevel

Úroveň rezervace kapacity v GB pro tento pracovní prostor, když je vybraná sku CapacityReservation.

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

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

Stav příjmu dat pro tento pracovní prostor.

Name	Typ	Description
ApproachingQuota	string	Dosáhli jsme 80 % denní kvóty.
ForceOff	string	Příjem dat se zastavil po změně nastavení služby.
ForceOn	string	Příjem dat začal po změně nastavení služby.
OverQuota	string	Dosáhli jsme denní kvóty maximálního limitu, příjem dat se zastavil.
RespectQuota	string	Příjem dat byl povolen po resetování denní kvóty nebo povolení předplatného.
SubscriptionSuspended	string	Příjem dat se zastavil po pozastavené předplatné.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Identity

Identita prostředku.

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity prostředku.
tenantId	string	ID tenanta prostředku.
type	IdentityType	Typ identity spravované služby
userAssignedIdentities	<string,  UserIdentityProperties>	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

IdentityType

Typ identity spravované služby

Name	Typ	Description
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

Referenční informace k prostředku oboru privátního propojení

Name	Typ	Description
resourceId	string	Úplné ID prostředku oboru privátního propojení
scopeId	string	Jedinečný identifikátor oboru privátního propojení.

PublicNetworkAccessType

Typ síťového přístupu pro provoz v pracovním prostoru služby Log Analytics. Ve výchozím nastavení je povoleno.

Name	Typ	Description
Disabled	string	Zakáže veřejné připojení ke službě Log Analytics prostřednictvím veřejného DNS.
Enabled	string	Umožňuje připojení ke službě Log Analytics prostřednictvím veřejného DNS.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserIdentityProperties

Vlastnosti identity přiřazené uživatelem.

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.

Workspace

Kontejner prostředků pracovního prostoru nejvyšší úrovně.

Name	Typ	Default value	Description
etag	string		Značka etag pracovního prostoru.
id	string		Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Identita prostředku.
location	string		Geografické umístění, ve kterém se nachází prostředek
name	string		Název prostředku
properties.createdDate	string		Datum vytvoření pracovního prostoru
properties.customerId	string		Toto je vlastnost jen pro čtení. Představuje ID přidružené k pracovnímu prostoru.
properties.defaultDataCollectionRuleResourceId	string		ID prostředku výchozího pravidla shromažďování dat, které se má použít pro tento pracovní prostor. Očekávaný formát je - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features	WorkspaceFeatures		Funkce pracovního prostoru.
properties.forceCmkForQuery	boolean		Určuje, jestli je úložiště spravované zákazníkem povinné pro správu dotazů.
properties.modifiedDate	string		Datum změny pracovního prostoru.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Seznam prostředků propojeného oboru privátního propojení
properties.provisioningState	WorkspaceEntityStatus		Stav zřizování pracovního prostoru.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Typ síťového přístupu pro přístup k příjmu dat v Log Analytics.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Typ síťového přístupu pro přístup k dotazu Log Analytics.
properties.retentionInDays	integer		Uchovávání dat pracovního prostoru ve dnech. Povolené hodnoty jsou pro cenový plán. Podrobnosti najdete v dokumentaci k cenám.
properties.sku	WorkspaceSku		Skladová položka pracovního prostoru.
properties.workspaceCapping	WorkspaceCapping		Denní limit objemu pro příjem dat.
systemData	systemData		Metadata týkající se vytvoření a poslední změny prostředku
tags	object		Značky prostředků.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

WorkspaceCapping

Denní limit objemu pro příjem dat.

Name	Typ	Description
dailyQuotaGb	number	Denní kvóta pracovního prostoru pro příjem dat.
dataIngestionStatus	DataIngestionStatus	Stav příjmu dat pro tento pracovní prostor.
quotaNextResetTime	string	Čas, kdy bude kvóta odpočinutá.

WorkspaceEntityStatus

Stav zřizování pracovního prostoru.

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

WorkspaceFeatures

Funkce pracovního prostoru.

Name	Typ	Description
clusterResourceId	string	Id prostředku vyhrazeného clusteru LA, který je propojený s pracovními prostory.
disableLocalAuth	boolean	Zakažte ověřování jiného než AAD.
enableDataExport	boolean	Příznak, který označuje, jestli se mají exportovat data.
enableLogAccessUsingOnlyResourcePermissions	boolean	Příznak označující, které oprávnění se má použít – prostředek nebo pracovní prostor nebo obojí.
immediatePurgeDataOn30Days	boolean	Příznak, který popisuje, jestli chceme data po 30 dnech odebrat.
unifiedSentinelBillingOnly	boolean	Informace o tom, jestli je zadaný pracovní prostor omezený pouze na model sjednocené fakturace služby Sentinel.

WorkspaceListResult

Odpověď operace pracovních prostorů seznamu

Name	Typ	Description
value	Workspace[]	Seznam pracovních prostorů.

WorkspaceSku

Skladová položka (úroveň) pracovního prostoru.

Name	Typ	Description
capacityReservationLevel	CapacityReservationLevel	Úroveň rezervace kapacity v GB pro tento pracovní prostor, když je vybraná sku CapacityReservation.
lastSkuUpdate	string	Čas poslední aktualizace skladové položky.
name	WorkspaceSkuNameEnum	Název skladové položky.

WorkspaceSkuNameEnum

Název skladové položky.

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