Workspace Purge - Get Purge Status

Layanan:

Log Analytics

Versi API:

2025-02-01

Mendapatkan status operasi pembersihan yang sedang berlangsung.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}?api-version=2025-02-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
purgeId	path	True	string	Dalam permintaan status penghapusan menyeluruh, ini adalah Id operasi yang statusnya dikembalikan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nama ruang kerja.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	WorkspacePurgeStatusResponse	Mengembalikan status operasi pembersihan dalam isi respons. misalnya: berjalan, selesai.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

WorkspacePurgeOperation

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/aztest5048/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2025-02-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.OperationalInsights.Models;
using Azure.ResourceManager.OperationalInsights;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2025-02-01/examples/WorkspacesPurgeOperation.json
// this example is just showing the usage of "WorkspacePurge_GetPurgeStatus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this OperationalInsightsWorkspaceResource created on azure
// for more information of creating OperationalInsightsWorkspaceResource, please refer to the document of OperationalInsightsWorkspaceResource
string subscriptionId = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "OIAutoRest5123";
string workspaceName = "aztest5048";
ResourceIdentifier operationalInsightsWorkspaceResourceId = OperationalInsightsWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
OperationalInsightsWorkspaceResource operationalInsightsWorkspace = client.GetOperationalInsightsWorkspaceResource(operationalInsightsWorkspaceResourceId);

// invoke the operation
string purgeId = "purge-970318e7-b859-4edb-8903-83b1b54d0b74";
OperationalInsightsWorkspacePurgeStatusResult result = await operationalInsightsWorkspace.GetPurgeStatusAsync(purgeId);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:

200

{
  "status": "completed"
}

Definisi

Nama	Deskripsi
PurgeState	Status operasi yang diwakili oleh Id yang diminta.
WorkspacePurgeStatusResponse	Respons yang berisi status untuk operasi penghapusan menyeluruh tertentu.

PurgeState

Enumeration

Status operasi yang diwakili oleh Id yang diminta.

Nilai	Deskripsi
completed
pending

WorkspacePurgeStatusResponse

Objek

Respons yang berisi status untuk operasi penghapusan menyeluruh tertentu.

Nama	Jenis	Deskripsi
status	PurgeState	Status operasi yang diwakili oleh Id yang diminta.