Components - Purge

Ссылка

Service:: Application Insights

API Version:: 2015-05-01

Очищает данные в компоненте Application Insights с помощью набора определяемых пользователем фильтров.

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge?api-version=2015-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
resourceName	path	True	string	Имя ресурса компонента Application Insights.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
filters	True	ComponentPurgeBodyFilters[]	Набор столбцов и фильтров (запросов), выполняемых по ним для очистки результирующих данных.
table	True	string	Таблица, из которой выполняется очистка данных.

Ответы

Имя	Тип	Описание
202 Accepted	ComponentPurgeResponse	Принятый запрос на очистку компонента Application Insights.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

ComponentPurge

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/OIAutoRest5123/providers/Microsoft.Insights/components/aztest5048/purge?api-version=2015-05-01

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

Sample Response

Status code:: 202

x-ms-status-location: https://management.azure.com/subscriptions/b96161de-b34a-480f-7343-59b099299283/resourceGroups/example/providers/microsoft.insights/components/test/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2015-05-01

Response Body

{
  "operationId": "7d7cf277-9113-4ab3-8359-d0364b74d01d"
}

Определения

Имя	Описание
ComponentPurgeBody	Описывает текст запроса на очистку для компонента App Insights.
ComponentPurgeBodyFilters	Определяемые пользователем фильтры для возврата данных, которые будут удалены из таблицы.
ComponentPurgeResponse	Ответ, содержащий operationId для определенного действия очистки.

ComponentPurgeBody

Описывает текст запроса на очистку для компонента App Insights.

Имя	Тип	Описание
filters	ComponentPurgeBodyFilters[]	Набор столбцов и фильтров (запросов), выполняемых по ним для очистки результирующих данных.
table	string	Таблица, из которой выполняется очистка данных.

ComponentPurgeBodyFilters

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

Имя	Тип	Описание
column	string	Столбец таблицы, по которому должен выполняться заданный запрос.
key	string	При фильтрации по пользовательским измерениям этот ключ будет использоваться в качестве имени настраиваемого измерения.
operator	string	Оператор запроса для вычисления по предоставленным столбцам и значениям. Поддерживаемые операторы : ==, =~, in,in~, >, >=, <, <=, between и имеют то же поведение, что и в KQL-запросе.
value		значение для оператора, с помощью функции. Это может быть число (например, > 100), строка (метка >времени = 2017-09-01) или массив значений.

ComponentPurgeResponse

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

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