你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	WorkspaceListResult	正常响应定义。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
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"
      }
    }
  ]
}

定义

名称	说明
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 为单位）。

名称	类型	说明
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

此工作区的数据引入状态。

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

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

托管服务标识的类型。

名称	类型	说明
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

专用链接范围资源引用。

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

PublicNetworkAccessType

用于在 Log Analytics 工作区中操作的网络访问类型。 默认情况下，它处于启用状态

名称	类型	说明
Disabled	string	通过公共 DNS 禁用与 Log Analytics 的公共连接。
Enabled	string	通过公共 DNS 启用与 Log Analytics 的连接。

systemData

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

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

UserIdentityProperties

用户分配的标识属性。

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

Workspace

顶级工作区资源容器。

名称	类型	默认值	说明
etag	string		工作区的 etag。
id	string		资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		资源的标识。
location	string		资源所在的地理位置
name	string		资源的名称
properties.createdDate	string		工作区创建日期。
properties.customerId	string		这是只读属性。 表示与工作区关联的 ID。
properties.defaultDataCollectionRuleResourceId	string		要用于此工作区的默认数据收集规则的资源 ID。 预期格式为 - /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

每日引入量上限。

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

WorkspaceEntityStatus

工作区的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

工作区功能。

名称	类型	说明
clusterResourceId	string	链接到工作区的专用 LA 群集 resourceId。
disableLocalAuth	boolean	禁用基于非 AAD 的身份验证。
enableDataExport	boolean	指示是否应导出数据的标志。
enableLogAccessUsingOnlyResourcePermissions	boolean	指示要使用的权限的标志 - 资源或工作区或两者。
immediatePurgeDataOn30Days	boolean	描述是否要在 30 天后删除数据的标志。
unifiedSentinelBillingOnly	boolean	指示指定工作区是否仅限于 sentinel 的统一计费模型。

WorkspaceListResult

列表工作区操作响应。

名称	类型	说明
value	Workspace[]	工作区列表。

WorkspaceSku

SKU (层) 工作区。

名称	类型	说明
capacityReservationLevel	CapacityReservationLevel	选择 CapacityReservation SKU 时，此工作区的容量预留级别（以 GB 为单位）。
lastSkuUpdate	string	上次更新 SKU 的时间。
name	WorkspaceSkuNameEnum	SKU 的名称。

WorkspaceSkuNameEnum

SKU 的名称。

名称	类型	说明
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string