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 minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	WorkspaceListResult	OK определение ответа.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

WorkspacesSubscriptionList

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
DataIngestionStatus	Состояние приема данных для этой рабочей области.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
Identity	Удостоверение ресурса.
PrivateLinkScopedResource	Список ресурсов области связанного приватного канала.
PublicNetworkAccessType	Тип сетевого доступа для доступа к приему Log Analytics.
ResourceIdentityType	Тип удостоверения.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
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

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

Identity

Object

Удостоверение ресурса.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта удостоверения ресурса. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
tenantId	string (uuid)	Идентификатор клиента ресурса. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
type	ResourceIdentityType	Тип удостоверения.

PrivateLinkScopedResource

Object

Список ресурсов области связанного приватного канала.

Имя	Тип	Описание
resourceId	string	Полный идентификатор ресурса области приватного канала.
scopeId	string	Уникальный идентификатор области приватного канала.

PublicNetworkAccessType

Перечисление

Тип сетевого доступа для доступа к приему Log Analytics.

Значение	Описание
Enabled	Обеспечивает подключение к Log Analytics через общедоступный DNS.
Disabled	Отключает общедоступное подключение к Log Analytics через общедоступный DNS.
SecuredByPerimeter	Доступ к ресурсу возможен только из частных сетей, а доступ разрешен периметром безопасности сети, связанным с этим ресурсом.

ResourceIdentityType

Перечисление

Тип удостоверения.

Значение	Описание
SystemAssigned

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Workspace

Object

Список рабочих областей.

Имя	Тип	Default value	Описание
etag	string		Etag рабочей области.
id	string		Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Удостоверение ресурса.
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса
properties.createdDate	string (date-time)		Дата создания рабочего пространства.
properties.customerId	string		Это свойство доступно только для чтения. Представляет идентификатор, связанный с рабочей областью.
properties.defaultDataCollectionRuleResourceId	string		Идентификатор ресурса правила сбора данных по умолчанию, используемого для этой рабочей области. Ожидаемый формат : /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		Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WorkspaceCapping

Object

Ежедневное ограничение тома для приема.

Имя	Тип	Описание
dailyQuotaGb	number (double)	Ежедневная квота рабочей области для приема.
dataIngestionStatus	DataIngestionStatus	Состояние приема данных для этой рабочей области.
quotaNextResetTime	string	Время, когда норма будет отдыхать.

WorkspaceEntityStatus

Перечисление

Состояние подготовки рабочей области.

Значение	Описание
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

WorkspaceFailoverProperties

Object

Свойства отработки отказа рабочей области.

Имя	Тип	Описание
lastModifiedDate	string (date-time)	Время последнего обновления состояния отработки отказа.
state	WorkspaceFailoverState	Состояние отработки отказа репликации.

WorkspaceFailoverState

Перечисление

Состояние отработки отказа репликации.

Значение	Описание
Inactive
Activating
Active
Deactivating
Failed

WorkspaceFeatures

Object

Функции рабочей области.

Имя	Тип	Описание
associations	string[]	Список ассоциаций для рабочей области. Указывает, связана ли рабочая область с каким-либо из следующих интерфейсов: MDC, Sentinel, SentinelGraph и т. д.
clusterResourceId	string	Выделенный идентификатор ресурса кластера LA, связанный с рабочими областями.
disableLocalAuth	boolean	Отключите проверку подлинности, отличной от AAD.
enableDataExport	boolean	Флаг, указывающий, следует ли экспортировать данные.
enableLogAccessUsingOnlyResourcePermissions	boolean	Пометка, указывающая, какое разрешение на использование — ресурс или рабочая область или оба.
immediatePurgeDataOn30Days	boolean	Флаг, описывающий, следует ли удалять данные через 30 дней.
unifiedSentinelBillingOnly	boolean	Указание на то, что указанное рабочее пространство ограничено только единой моделью выставления счетов Sentinel.

WorkspaceListResult

Object

Ответ на операцию с рабочими областями списка.

Имя	Тип	Описание
value	Workspace[]	Список рабочих областей.

WorkspaceReplicationProperties

Object

Свойства репликации рабочей области.

Имя	Тип	Описание
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

Object

Номер SKU рабочей области.

Имя	Тип	Описание
capacityReservationLevel	integer (int32)	Уровень резервирования емкости в ГБ для этой рабочей области при выборе номера SKU CapacityReservation.
lastSkuUpdate	string (date-time)	Последний раз когда обновлялся артикул.
name	WorkspaceSkuNameEnum	Имя номера SKU.

WorkspaceSkuNameEnum

Перечисление

Имя номера SKU.

Значение	Описание
Free
Standard
Premium
PerNode
PerGB2018
Standalone
CapacityReservation
LACluster

Поделиться через

Workspaces - List

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

WorkspacesSubscriptionList

Образец запроса

Пример ответа

Определения

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

PrivateLinkScopedResource

PublicNetworkAccessType

ResourceIdentityType

systemData

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceListResult

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum