Workspaces - Create Or Update

Ссылка

Служба:: Log Analytics

Версия API:: 2025-02-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}?api-version=2025-02-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Имя рабочей области.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
etag		string	Etag рабочей области.
identity		Identity	Удостоверение ресурса.
properties.defaultDataCollectionRuleResourceId		string	Идентификатор ресурса правила сбора данных по умолчанию, используемого для этой рабочей области. Ожидаемый формат : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.failover		WorkspaceFailoverProperties	Свойства отработки отказа рабочей области.
properties.features		WorkspaceFeatures	Функции рабочей области.
properties.forceCmkForQuery		boolean	Указывает, является ли управляемое клиентом хранилище обязательным для управления запросами.
properties.publicNetworkAccessForIngestion		PublicNetworkAccessType	Тип сетевого доступа для доступа к приему Log Analytics.
properties.publicNetworkAccessForQuery		PublicNetworkAccessType	Тип доступа к сети для доступа к запросу Log Analytics.
properties.replication		WorkspaceReplicationProperties	Свойства репликации рабочей области.
properties.retentionInDays		integer (int32)	Хранение данных рабочей области в днях. Допустимые значения — на тарифный план. Дополнительные сведения см. в документации по ценовой категории.
properties.sku		WorkspaceSku	Номер SKU рабочей области.
properties.workspaceCapping		WorkspaceCapping	Ежедневное ограничение тома для приема.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	Workspace	ОК определение ответа.
201 Created	Workspace	Создано определение ответа.
202 Accepted		Принятый
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

WorkspacesCreate

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

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685?api-version=2025-02-01

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30
  },
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  }
}

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

Код состояния:: 200

{
  "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"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}

Код состояния:: 201

{
  "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"
  },
  "properties": {
    "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
    "provisioningState": "Creating",
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled"
  }
}

Код состояния:: 202

Определения

Имя	Описание
CapacityReservationLevel	Уровень резервирования емкости в ГБ для этой рабочей области при выборе номера SKU CapacityReservation.
createdByType	Тип удостоверения, создавшего ресурс.
DataIngestionStatus	Состояние приема данных для этой рабочей области.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
Identity	Удостоверение ресурса.
IdentityType	Тип управляемого удостоверения службы.
PrivateLinkScopedResource	Ссылка на ресурс области приватного канала.
PublicNetworkAccessType	Тип сетевого доступа для работы в рабочей области Log Analytics. По умолчанию она включена
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserIdentityProperties	Свойства назначаемого пользователем удостоверения.
Workspace	Контейнер ресурсов рабочей области верхнего уровня.
WorkspaceCapping	Ежедневное ограничение тома для приема.
WorkspaceEntityStatus	Состояние подготовки рабочей области.
WorkspaceFailoverProperties	Состояние отработки отказа репликации.
WorkspaceFailoverState	Состояние отработки отказа репликации.
WorkspaceFeatures	Функции рабочей области.
WorkspaceReplicationProperties	Свойства репликации рабочей области.
WorkspaceReplicationState	Состояние подготовки репликации.
WorkspaceSku	Номер SKU (уровень) рабочей области.
WorkspaceSkuNameEnum	Имя номера SKU.

CapacityReservationLevel

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

Уровень резервирования емкости в ГБ для этой рабочей области при выборе номера SKU CapacityReservation.

Значение	Описание
100
1000
10000
200
2000
25000
300
400
500
5000
50000

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

DataIngestionStatus

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

Состояние приема данных для этой рабочей области.

Значение	Описание
ApproachingQuota	Достигнуто 80% ежедневной квоты ограничения.
ForceOff	Прием остановился после изменения параметра службы.
ForceOn	Прием начался после изменения параметра службы.
OverQuota	Достигнута квота ежедневного ограничения, прием остановлен.
RespectQuota	Прием включен после ежедневного сброса квоты ограничения или включения подписки.
SubscriptionSuspended	Прием остановлен после приостановленной подписки.

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	Идентификатор субъекта удостоверения ресурса.
tenantId	string	Идентификатор клиента ресурса.
type	IdentityType	Тип управляемого удостоверения службы.
userAssignedIdentities	<string, UserIdentityProperties>	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

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

Тип управляемого удостоверения службы.

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

PrivateLinkScopedResource

Object

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

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

PublicNetworkAccessType

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

Тип сетевого доступа для работы в рабочей области Log Analytics. По умолчанию она включена

Значение	Описание
Disabled	Отключает общедоступное подключение к Log Analytics через общедоступный DNS.
Enabled	Включает подключение к Log Analytics через общедоступный DNS.

systemData

Object

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

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

UserIdentityProperties

Object

Свойства назначаемого пользователем удостоверения.

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначаемого пользователем удостоверения.
principalId	string	Идентификатор субъекта назначаемого пользователем удостоверения.

Workspace

Object

Контейнер ресурсов рабочей области верхнего уровня.

Имя	Тип	Default value	Описание
etag	string		Etag рабочей области.
id	string		Полный идентификатор ресурса для ресурса. Ex - /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

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

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

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

WorkspaceFailoverProperties

Object

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

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

WorkspaceFailoverState

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

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

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

WorkspaceFeatures

Object

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

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

WorkspaceReplicationProperties

Object

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

Имя	Тип	Описание
createdDate	string (date-time)	Последний раз, когда репликация была включена.
enabled	boolean	Указывает, включена ли репликация. Если задано значение true, конфигурация рабочей области и данные реплицируются в указанное расположение. Если репликация включена, необходимо указать расположение.
lastModifiedDate	string (date-time)	Время последнего обновления репликации.
location	string	Расположение репликации.
provisioningState	WorkspaceReplicationState	Состояние подготовки репликации.

WorkspaceReplicationState

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

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

Значение	Описание
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

WorkspaceSku

Object

Номер SKU (уровень) рабочей области.

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

WorkspaceSkuNameEnum

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

Имя номера SKU.

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

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

Workspaces - Create Or Update

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

WorkspacesCreate

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

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

Определения

CapacityReservationLevel

createdByType

DataIngestionStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

IdentityType

PrivateLinkScopedResource

PublicNetworkAccessType

systemData

UserIdentityProperties

Workspace

WorkspaceCapping

WorkspaceEntityStatus

WorkspaceFailoverProperties

WorkspaceFailoverState

WorkspaceFeatures

WorkspaceReplicationProperties

WorkspaceReplicationState

WorkspaceSku

WorkspaceSkuNameEnum

Дополнительные ресурсы