Workspaces - List

參考

Service:: Log Analytics

API Version:: 2023-09-01

取得訂用帳戶中的工作區。

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	WorkspaceListResult	確定回應定義。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

定義

名稱	Description
CapacityReservationLevel	選取 CapacityReservation sku 時，此工作區的容量保留層級為 GB。
createdByType	建立資源的身分識別類型。
DataIngestionStatus	此工作區的數據擷取狀態。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Identity	資源的身分識別。
IdentityType	受控服務識別的類型。
PrivateLinkScopedResource	私人鏈接範圍資源參考。
PublicNetworkAccessType	在 Log Analytics 工作區上運作的網路存取類型。預設為 [已啟用]
systemData	與建立和上次修改資源相關的元數據。
UserIdentityProperties	使用者指派的身分識別屬性。
Workspace	最上層工作區資源容器。
WorkspaceCapping	擷取的每日磁碟區上限。
WorkspaceEntityStatus	工作區的布建狀態。
WorkspaceFeatures	工作區功能。
WorkspaceListResult	清單工作區作業回應。
WorkspaceSku	工作區的 SKU (層) 。
WorkspaceSkuNameEnum	SKU 的名稱。

CapacityReservationLevel

選取 CapacityReservation sku 時，此工作區的容量保留層級為 GB。

名稱	類型	Description
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

此工作區的數據擷取狀態。

名稱	類型	Description
ApproachingQuota	string	達到每日上限配額的80%。
ForceOff	string	擷取在服務設定變更之後停止。
ForceOn	string	擷取開始遵循服務設定變更。
OverQuota	string	已達到每日上限配額，擷取已停止。
RespectQuota	string	在每日上限配額重設或訂用帳戶啟用之後啟用擷取。
SubscriptionSuspended	string	擷取在暫停的訂用帳戶之後停止。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

Identity

資源的身分識別。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	IdentityType	受控服務識別的類型。
userAssignedIdentities	<string, UserIdentityProperties>	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

IdentityType

受控服務識別的類型。

名稱	類型	Description
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

私人鏈接範圍資源參考。

名稱	類型	Description
resourceId	string	私人連結範圍資源的完整資源標識碼。
scopeId	string	私人連結範圍唯一標識碼。

PublicNetworkAccessType

在 Log Analytics 工作區上運作的網路存取類型。預設為 [已啟用]

名稱	類型	Description
Disabled	string	停用透過公用 DNS 對 Log Analytics 的公用連線。
Enabled	string	允許透過公用 DNS 連線到 Log Analytics。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserIdentityProperties

使用者指派的身分識別屬性。

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。

Workspace

最上層工作區資源容器。

名稱	類型	預設值	Description
etag	string		工作區的 etag。
id	string		資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		資源的身分識別。
location	string		資源所在的地理位置
name	string		資源的名稱
properties.createdDate	string		工作區建立日期。
properties.customerId	string		這是一個唯讀屬性。表示與工作區相關聯的標識碼。
properties.defaultDataCollectionRuleResourceId	string		要用於此工作區之預設數據收集規則的資源識別碼。預期的格式為 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}。
properties.features	WorkspaceFeatures		工作區功能。
properties.forceCmkForQuery	boolean		指出客戶管理的記憶體是否為查詢管理的必要專案。
properties.modifiedDate	string		工作區修改日期。
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		連結的私人連結範圍資源清單。
properties.provisioningState	WorkspaceEntityStatus		工作區的布建狀態。
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	用於存取 Log Analytics 擷取的網路存取類型。
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	用於存取 Log Analytics 查詢的網路存取類型。
properties.retentionInDays	integer		工作區數據保留天數。允許的值是每個定價方案。如需詳細資訊，請參閱定價層檔。
properties.sku	WorkspaceSku		工作區的 SKU。
properties.workspaceCapping	WorkspaceCapping		擷取的每日磁碟區上限。
systemData	systemData		與建立和上次修改資源相關的元數據。
tags	object		資源標籤。
type	string		資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

WorkspaceCapping

擷取的每日磁碟區上限。

名稱	類型	Description
dailyQuotaGb	number	擷取的工作區每日配額。
dataIngestionStatus	DataIngestionStatus	此工作區的數據擷取狀態。
quotaNextResetTime	string	配額將靜止的時間。

WorkspaceEntityStatus

工作區的布建狀態。

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

工作區功能。

名稱	類型	Description
clusterResourceId	string	連結至工作區的專用LA叢集 resourceId。
disableLocalAuth	boolean	停用非 AAD 型驗證。
enableDataExport	boolean	旗標，指出是否應該匯出數據。
enableLogAccessUsingOnlyResourcePermissions	boolean	旗標，指出要使用的許可權 - 資源或工作區或兩者。
immediatePurgeDataOn30Days	boolean	旗標，描述我們想要在 30 天后移除數據。
unifiedSentinelBillingOnly	boolean	指定工作區是否僅限於 sentinel 的統一計費模型。

WorkspaceListResult

清單工作區作業回應。

名稱	類型	Description
value	Workspace[]	工作區清單。

WorkspaceSku

工作區的 SKU (層) 。

名稱	類型	Description
capacityReservationLevel	CapacityReservationLevel	選取 CapacityReservation sku 時，此工作區的容量保留層級為 GB。
lastSkuUpdate	string	上次更新 SKU 的時間。
name	WorkspaceSkuNameEnum	SKU 的名稱。

WorkspaceSkuNameEnum

SKU 的名稱。

名稱	類型	Description
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string