Components - Purge

リファレンス

Service:: Application Insights

API Version:: 2015-05-01

一連のユーザー定義フィルターによって Application Insights コンポーネントのデータを消去します。

システムリソースを管理するために、消去要求は 1 時間あたり 50 要求に制限されます。消去要求の実行をバッチ処理するには、消去が必要なすべてのユーザー ID を述語に含む 1 つのコマンドを送信します。複数の ID を指定するには、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	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
filters	True	ComponentPurgeBodyFilters[]	結果のデータを消去するために実行する列とフィルター (クエリ) のセット。
table	True	string	データの消去元となるテーブル。

応答

名前	型	説明
202 Accepted	ComponentPurgeResponse	Application Insights コンポーネントを消去するための受け入れられた要求。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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~、、、>=、><=<、=、between で、KQL クエリと同じ動作をします。
value		演算子が機能する値。これには、数値 (100 など)、 > 文字列 (timestamp >= '2017-09-01') または値の配列を指定できます。

ComponentPurgeResponse

特定の消去アクションの operationId を含む応答。

名前	型	説明
operationId	string	特定の消去操作の状態を照会するときに使用する ID。