Workspace Purge - Purge

Service:

Log Analytics

API Version:

2020-08-01

Menghapus menyeluruh data di ruang kerja Analitik Log oleh sekumpulan filter yang ditentukan pengguna.

Untuk mengelola sumber daya sistem, permintaan pembersihan dibatasi 50 permintaan per jam. Anda harus mengelompokkan eksekusi permintaan pembersihan dengan mengirim satu perintah yang predikatnya mencakup semua identitas pengguna yang memerlukan pembersihan. Gunakan operator dalam untuk menentukan beberapa identitas. Anda harus menjalankan kueri sebelum menggunakan untuk permintaan pembersihan untuk memverifikasi bahwa hasilnya diharapkan. Analitik Log hanya mendukung operasi penghapusan menyeluruh yang diperlukan untuk kepatuhan terhadap GDPR. Tim produk Analitik Log berhak menolak permintaan untuk operasi penghapusan menyeluruh yang bukan untuk tujuan kepatuhan GDPR. Jika terjadi perselisihan, silakan buat tiket dukungan

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge?api-version=2020-08-01

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
workspaceName	path	True	string	Nama ruang kerja. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name	Required	Type	Description
filters	True	WorkspacePurgeBodyFilters[]	Kumpulan kolom dan filter (kueri) untuk dijalankan di atasnya untuk menghapus menyeluruh data yang dihasilkan.
table	True	string	Tabel dari mana data akan dibersihkan.

Respons

Name	Type	Description
202 Accepted	WorkspacePurgeResponse	Permintaan yang diterima untuk menghapus menyeluruh ruang kerja Analitik Log. Headers x-ms-status-location: string

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

WorkspacePurge

WorkspacePurgeResourceId

WorkspacePurge

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.loganalytics.models.WorkspacePurgeBody;
import com.azure.resourcemanager.loganalytics.models.WorkspacePurgeBodyFilters;
import java.util.Arrays;

/** Samples for WorkspacePurge Purge. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/WorkspacesPurge.json
     */
    /**
     * Sample code: WorkspacePurge.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void workspacePurge(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager
            .workspacePurges()
            .purgeWithResponse(
                "OIAutoRest5123",
                "aztest5048",
                new WorkspacePurgeBody()
                    .withTable("Heartbeat")
                    .withFilters(
                        Arrays
                            .asList(
                                new WorkspacePurgeBodyFilters()
                                    .withColumn("TimeGenerated")
                                    .withOperator(">")
                                    .withValue("2017-09-01T00:00:00"))),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armoperationalinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/operationalinsights/armoperationalinsights/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/WorkspacesPurge.json
func ExampleWorkspacePurgeClient_Purge() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armoperationalinsights.NewWorkspacePurgeClient("00000000-0000-0000-0000-00000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Purge(ctx,
		"OIAutoRest5123",
		"aztest5048",
		armoperationalinsights.WorkspacePurgeBody{
			Filters: []*armoperationalinsights.WorkspacePurgeBodyFilters{
				{
					Column:   to.Ptr("TimeGenerated"),
					Operator: to.Ptr(">"),
					Value:    "2017-09-01T00:00:00",
				}},
			Table: to.Ptr("Heartbeat"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { OperationalInsightsManagementClient } = require("@azure/arm-operationalinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
 *
 * @summary Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/WorkspacesPurge.json
 */
async function workspacePurge() {
  const subscriptionId = "00000000-0000-0000-0000-00000000000";
  const resourceGroupName = "OIAutoRest5123";
  const workspaceName = "aztest5048";
  const body = {
    filters: [{ column: "TimeGenerated", operator: ">", value: "2017-09-01T00:00:00" }],
    table: "Heartbeat",
  };
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.workspacePurge.purge(resourceGroupName, workspaceName, body);
  console.log(result);
}

workspacePurge().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

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=2020-08-01

Response Body

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

WorkspacePurgeResourceId

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.loganalytics.models.WorkspacePurgeBody;
import com.azure.resourcemanager.loganalytics.models.WorkspacePurgeBodyFilters;
import java.util.Arrays;

/** Samples for WorkspacePurge Purge. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/WorkspacesPurgeResourceId.json
     */
    /**
     * Sample code: WorkspacePurgeResourceId.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void workspacePurgeResourceId(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager
            .workspacePurges()
            .purgeWithResponse(
                "OIAutoRest5123",
                "aztest5048",
                new WorkspacePurgeBody()
                    .withTable("Heartbeat")
                    .withFilters(
                        Arrays
                            .asList(
                                new WorkspacePurgeBodyFilters()
                                    .withColumn("_ResourceId")
                                    .withOperator("==")
                                    .withValue(
                                        "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/SomeResourceGroup/providers/microsoft.insights/components/AppInsightResource"))),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

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=2020-08-01

Response Body

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

Definisi

WorkspacePurgeBody	Menjelaskan isi permintaan pembersihan untuk Ruang Kerja App Insights
WorkspacePurgeBodyFilters	Filter yang ditentukan pengguna untuk mengembalikan data yang akan dihapus menyeluruh dari tabel.
WorkspacePurgeResponse	Respons yang berisi operationId untuk tindakan pembersihan tertentu.

WorkspacePurgeBody

Menjelaskan isi permintaan pembersihan untuk Ruang Kerja App Insights

Name	Type	Description
filters	WorkspacePurgeBodyFilters[]	Kumpulan kolom dan filter (kueri) untuk dijalankan di atasnya untuk menghapus menyeluruh data yang dihasilkan.
table	string	Tabel dari mana data akan dibersihkan.

WorkspacePurgeBodyFilters

Filter yang ditentukan pengguna untuk mengembalikan data yang akan dihapus menyeluruh dari tabel.

Name	Type	Description
column	string	Kolom tabel tempat kueri yang diberikan harus dijalankan
key	string	Saat memfilter dimensi kustom, kunci ini akan digunakan sebagai nama dimensi kustom.
operator	string	Operator kueri untuk mengevaluasi kolom dan nilai yang disediakan. Operator yang didukung adalah ==, =~, in, in~, >, >=, <, <=, between, dan memiliki perilaku yang sama seperti yang mereka lakukan dalam kueri KQL.
value		nilai bagi operator untuk berfungsi. Ini bisa berupa angka (misalnya, > 100), string (tanda >waktu = '2017-09-01') atau array nilai.

WorkspacePurgeResponse

Respons yang berisi operationId untuk tindakan pembersihan tertentu.

Name	Type	Description
operationId	string	Id yang digunakan saat mengkueri status untuk operasi pembersihan tertentu.