Workspaces - List

服务:

Log Analytics

API 版本:

2025-07-01

获取订阅中的工作区。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	WorkspaceListResult	Azure 运营顺利完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

WorkspacesSubscriptionList

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.OperationalInsights/workspaces?api-version=2025-07-01

示例响应

状态代码:

200

{
  "value": [
    {
      "name": "AzTest2170",
      "type": "Microsoft.OperationalInsights/workspaces",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
      "location": "australiasoutheast",
      "properties": {
        "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
        "provisioningState": "Succeeded",
        "publicNetworkAccessForIngestion": "Enabled",
        "publicNetworkAccessForQuery": "Enabled",
        "retentionInDays": 30,
        "sku": {
          "name": "PerGB2018"
        }
      },
      "tags": {
        "tag1": "val1"
      }
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DataIngestionStatus	此工作区的数据摄取状态。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Identity	资源的标识。
IdentityType	托管服务标识的类型。
PrivateLinkScopedResource	专用链接范围资源参考。
PublicNetworkAccessType	用于访问 Log Analytics 引入的网络访问类型。
systemData	与创建和上次修改资源相关的元数据。
UserIdentityProperties	用户分配的标识属性。
Workspace	顶级工作区资源容器。
WorkspaceCapping	引入的每日量上限。
WorkspaceEntityStatus	工作区的预配状态。
WorkspaceFailoverProperties	复制的故障转移状态。
WorkspaceFailoverState	复制的故障转移状态。
WorkspaceFeatures	工作区功能。
WorkspaceListResult	列表工作空间作响应。
WorkspaceReplicationProperties	工作区复制属性。
WorkspaceReplicationState	复制的预配状态。
WorkspaceSku	工作区的 SKU（层）。
WorkspaceSkuNameEnum	SKU 的名称。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DataIngestionStatus

枚举

此工作区的数据摄取状态。

值	说明
RespectQuota	在每日上限配额重置或订阅启用后启用引入。
ForceOn	服务设置更改后开始引入。
ForceOff	服务设置更改后引入停止。
OverQuota	已达到每日上限配额，引入已停止。
SubscriptionSuspended	订阅暂停后，摄取停止。
ApproachingQuota	达到每日上限配额的 80%。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Identity

对象

资源的标识。

名称	类型	说明
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	IdentityType	托管服务标识的类型。
userAssignedIdentities	<string,  UserIdentityProperties>	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

IdentityType

枚举

托管服务标识的类型。

值	说明
SystemAssigned	系统分配
UserAssigned	UserAssigned
None	None

PrivateLinkScopedResource

对象

专用链接范围资源参考。

名称	类型	说明
resourceId	string	专用链接范围资源的完整资源 ID。
scopeId	string	专用链接范围唯一标识符。

PublicNetworkAccessType

枚举

用于访问 Log Analytics 引入的网络访问类型。

值	说明
Enabled	通过公共 DNS 启用与 Log Analytics 的连接。
Disabled	禁用通过公共 DNS 与 Log Analytics 的公共连接。
SecuredByPerimeter	资源只能从专用网络访问，并且访问由与此资源关联的网络安全外围批准。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserIdentityProperties

对象

用户分配的标识属性。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。

Workspace

对象

顶级工作区资源容器。

名称	类型	默认值	说明
etag	string		工作区的 etag。
id	string (arm-id)		资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	Identity		资源的标识。
location	string		资源所在的地理位置
name	string		资源的名称
properties.createdDate	string (date-time)		工作区创建日期。
properties.customerId	string		这是一个只读属性。 表示与工作区关联的 ID。
properties.defaultDataCollectionRuleResourceId	string		要用于此工作区的默认数据收集规则的资源 ID。 预期格式为 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}。
properties.failover	WorkspaceFailoverProperties		工作区故障转移属性。
properties.features	WorkspaceFeatures		工作区功能。
properties.forceCmkForQuery	boolean		指示客户托管存储是否强制进行查询管理。
properties.modifiedDate	string (date-time)		工作区修改日期。
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		链接的专用链接范围资源的列表。
properties.provisioningState	WorkspaceEntityStatus		工作区的预配状态。
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	用于访问 Log Analytics 引入的网络访问类型。
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	用于访问 Log Analytics 查询的网络访问类型。
properties.replication	WorkspaceReplicationProperties		工作区复制属性。
properties.retentionInDays	integer (int32)		工作区数据保留期（以天为单位）。 允许的值根据定价计划而定。 请参阅定价层文档了解详细信息。
properties.sku	WorkspaceSku		工作区的 SKU。
properties.workspaceCapping	WorkspaceCapping		引入的每日量上限。
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WorkspaceCapping

对象

引入的每日量上限。

名称	类型	说明
dailyQuotaGb	number (double)	引入的工作区每日配额。
dataIngestionStatus	DataIngestionStatus	此工作区的数据摄取状态。
quotaNextResetTime	string	配额休息的时间。

WorkspaceEntityStatus

枚举

工作区的预配状态。

值	说明
Creating	创建
Succeeded	成功
Failed	已失败
Canceled	已取消
Deleting	正在删除
ProvisioningAccount	配置账户
Updating	更新

WorkspaceFailoverProperties

对象

复制的故障转移状态。

名称	类型	说明
lastModifiedDate	string (date-time)	上次更新故障转移状态的时间。
state	WorkspaceFailoverState	复制的故障转移状态。

WorkspaceFailoverState

枚举

复制的故障转移状态。

值	说明
Inactive	未启用
Activating	正在激活
Active	积极
Deactivating	正在停用
Failed	已失败

WorkspaceFeatures

对象

工作区功能。

名称	类型	说明
associations	string[]	工作区的关联列表。 指示工作区是否与以下任何体验相关联：MDC、Sentinel、SentinelGraph 等。
clusterResourceId	string	链接到工作区的专用 LA 群集 resourceId。
disableLocalAuth	boolean	禁用基于非 AAD 的身份验证。
enableDataExport	boolean	指示是否应导出数据的标志。
enableLogAccessUsingOnlyResourcePermissions	boolean	指示使用哪个权限的标志 - 资源或工作区或两者。
immediatePurgeDataOn30Days	boolean	描述是否要在 30 天后删除数据的标志。
unifiedSentinelBillingOnly	boolean	指示指定工作区是否仅限于 Sentinel 的统一计费模型。

WorkspaceListResult

对象

列表工作空间作响应。

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	Workspace[]	工作区列表。

WorkspaceReplicationProperties

对象

工作区复制属性。

名称	类型	说明
createdDate	string (date-time)	上次启用复制的时间。
enabled	boolean	指定是否启用复制。 如果为 true，工作区配置和数据将复制到指定位置。 如果已启用复制，则必须提供位置。
lastModifiedDate	string (date-time)	上次更新复制的时间。
location	string	复制的位置。
provisioningState	WorkspaceReplicationState	复制的预配状态。

WorkspaceReplicationState

枚举

复制的预配状态。

值	说明
Succeeded	成功
EnableRequested	请求启用
Enabling	正在启用
DisableRequested	请求失能
Disabling	禁用
RollbackRequested	请求回滚
RollingBack	回滚
Failed	已失败
Canceled	已取消

WorkspaceSku

对象

工作区的 SKU（层）。

名称	类型	说明
capacityReservationLevel	integer (int32)	选择 CapacityReservation sku 时，此工作区的容量预留级别为 GB。
lastSkuUpdate	string (date-time)	上次更新 SKU 的时间。
name	WorkspaceSkuNameEnum	SKU 的名称。

WorkspaceSkuNameEnum

枚举

SKU 的名称。

值	说明
Free	免费
Standard	标准
Premium	高级
PerNode	PerNode
PerGB2018	PerGB2018
Standalone	独立
CapacityReservation	容量预留
LACluster	洛克莱斯特