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

Workspace Purge - Purge

  • Ссылка
Служба:
Log Analytics
Версия API:
2023-09-01

Очищает данные в рабочей области Log Analytics набором определяемых пользователем фильтров.

Для управления системными ресурсами запросы очистки регулируются по 50 запросов в час. Необходимо пакетировать выполнение запросов очистки, отправив одну команду, предикат которой включает все удостоверения пользователей, для которых требуется очистка. Используйте оператор in для указания нескольких удостоверений. Перед использованием запроса на очистку необходимо выполнить запрос, чтобы убедиться, что результаты ожидаются. Log Analytics поддерживает только операции очистки, необходимые для соответствия GDPR. Группа продуктов Log Analytics резервирует право отклонять запросы на операции очистки, которые не предназначены для соответствия GDPR. В случае спора создайте запрос в службу поддержки

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge?api-version=2023-09-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, используемая для этой операции.

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

Имя Обязательно Тип Описание
filters True

WorkspacePurgeBodyFilters[]

Набор столбцов и фильтров (запросов) для их выполнения для очистки результирующих данных.
table True

string

Таблица, из которой следует очистить данные.

Ответы

Имя Тип Описание
202 Accepted

WorkspacePurgeResponse

Принятый запрос на очистку рабочей области Log Analytics.

Заголовки

x-ms-status-location: string

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

WorkspacePurge
WorkspacePurgeResourceId

WorkspacePurge

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

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/aztest5048/purge?api-version=2023-09-01

{
  "table": "Heartbeat",
  "filters": [
    {
      "column": "TimeGenerated",
      "operator": ">",
      "value": "2017-09-01T00:00:00"
    }
  ]
}

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

Код состояния:
202 
x-ms-status-location: https://management.azure.com/subscriptions/b96161de-b34a-480f-7343-59b099299283/resourceGroups/example/providers/microsoft.operationalinsights/workspaces/test/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2023-09-01
{
  "operationId": "7d7cf277-9113-4ab3-8359-d0364b74d01d"
}

WorkspacePurgeResourceId

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

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/aztest5048/purge?api-version=2023-09-01

{
  "table": "Heartbeat",
  "filters": [
    {
      "column": "_ResourceId",
      "operator": "==",
      "value": "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/SomeResourceGroup/providers/microsoft.insights/components/AppInsightResource"
    }
  ]
}

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

Код состояния:
202 
x-ms-status-location: https://management.azure.com/subscriptions/b96161de-b34a-480f-7343-59b099299283/resourceGroups/example/providers/microsoft.operationalinsights/workspaces/test/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2023-09-01
{
  "operationId": "7d7cf277-9113-4ab3-8359-d0364b74d01d"
}

Определения

Имя Описание
WorkspacePurgeBody

Описание текста запроса на очистку рабочей области App Insights
WorkspacePurgeBodyFilters

Определяемые пользователем фильтры для возврата данных, которые будут удалены из таблицы.
WorkspacePurgeResponse

Ответ, содержащий operationId для определенного действия очистки.

WorkspacePurgeBody

Object

Описание текста запроса на очистку рабочей области App Insights

Имя Тип Описание
filters

WorkspacePurgeBodyFilters[]

Набор столбцов и фильтров (запросов) для их выполнения для очистки результирующих данных.
table

string

Таблица, из которой следует очистить данные.

WorkspacePurgeBodyFilters

Object

Определяемые пользователем фильтры для возврата данных, которые будут удалены из таблицы.

Имя Тип Описание
column

string

Столбец таблицы, над которой должен выполняться заданный запрос.
key

string

При фильтрации по пользовательским измерениям этот ключ будет использоваться в качестве имени настраиваемого измерения.
operator

string

Оператор запроса для оценки по заданному столбцу и значениям. Поддерживаемые операторы :=, =~, in, in, >, >=, <, <=, между ними и имеют то же поведение, что и в запросе KQL.
value

значение оператора для функции. Это может быть число (например, > 100), строка (метка времени >= '2017-09-01') или массив значений.

WorkspacePurgeResponse

Object

Ответ, содержащий operationId для определенного действия очистки.

Имя Тип Описание
operationId

string

Идентификатор, используемый при запросе состояния для определенной операции очистки.