Workspaces - Update

Ссылка

Service:: Log Analytics

API Version:: 2023-09-01

Обновления рабочей области.

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

Параметры URI

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

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

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

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

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

Примеры

WorkspacesPatch

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685?api-version=2023-09-01

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "workspaceCapping": {
      "dailyQuotaGb": -1
    }
  }
}

Sample Response

Status code:: 200

{
  "properties": {
    "sku": {
      "name": "PerGB2018"
    },
    "retentionInDays": 30,
    "publicNetworkAccessForQuery": "Enabled",
    "publicNetworkAccessForIngestion": "Enabled",
    "workspaceCapping": {
      "dailyQuotaGb": -1,
      "quotaNextResetTime": "Mon, 16 Nov 2020 15:00:00 GMT",
      "dataIngestionStatus": "RespectQuota"
    }
  },
  "location": "australiasoutheast",
  "tags": {
    "tag1": "val1"
  }
}

Определения

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

CapacityReservationLevel

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

Имя	Тип	Описание
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	Объект error.

Identity

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

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

IdentityType

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

Имя	Тип	Описание
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

Приватный канал область справочник по ресурсу.

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

PublicNetworkAccessType

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

Имя	Тип	Описание
Disabled	string	Отключает общедоступное подключение к Log Analytics через общедоступную СЛУЖБУ DNS.
Enabled	string	Обеспечивает подключение к Log Analytics через общедоступную службу DNS.

systemData

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

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

UserIdentityProperties

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

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

Workspace

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

Имя	Тип	Значение по умолчанию	Описание
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

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

Имя	Тип	Описание
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, связанный с рабочими областями.
disableLocalAuth	boolean	Отключите проверку подлинности, не основанную на AAD.
enableDataExport	boolean	Флаг, указывающий, следует ли экспортировать данные.
enableLogAccessUsingOnlyResourcePermissions	boolean	Флаг, указывающий, какое разрешение следует использовать: ресурс или рабочая область или и то, и другое.
immediatePurgeDataOn30Days	boolean	Флаг, который указывает, нужно ли удалить данные через 30 дней.
unifiedSentinelBillingOnly	boolean	Указывает, ограничена ли указанная рабочая область только единой моделью выставления счетов sentinel.

WorkspacePatch