Workspace Purge - Get Purge Status

サービス:

Log Analytics

API バージョン:

2025-07-01

進行中の消去操作の状態を取得します。

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

URI パラメーター

名前	/	必須	型	説明
purgeId	path	True	string	消去状態要求では、これは、状態が返される操作の ID です。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
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 バージョン。

応答

名前	型	説明
200 OK	WorkspacePurgeStatusResponse	Azureの運用は無事に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

WorkspacePurgeOperation

要求のサンプル

HTTP

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

Java

/**
 * Samples for WorkspacePurge GetPurgeStatus.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-07-01/WorkspacesPurgeOperation.json
     */
    /**
     * Sample code: WorkspacePurgeOperation.
     * 
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void workspacePurgeOperation(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager.workspacePurges().getPurgeStatusWithResponse("OIAutoRest5123", "aztest5048",
            "purge-970318e7-b859-4edb-8903-83b1b54d0b74", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python workspaces_purge_operation.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.workspace_purge.get_purge_status(
        resource_group_name="OIAutoRest5123",
        workspace_name="aztest5048",
        purge_id="purge-970318e7-b859-4edb-8903-83b1b54d0b74",
    )
    print(response)


# x-ms-original-file: 2025-07-01/WorkspacesPurgeOperation.json
if __name__ == "__main__":
    main()

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

Go

package armoperationalinsights_test

import (
	"context"
	"log"

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

// Generated from example definition: 2025-07-01/WorkspacesPurgeOperation.json
func ExampleWorkspacePurgeClient_GetPurgeStatus() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoperationalinsights.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspacePurgeClient().GetPurgeStatus(ctx, "OIAutoRest5123", "aztest5048", "purge-970318e7-b859-4edb-8903-83b1b54d0b74", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armoperationalinsights.WorkspacePurgeClientGetPurgeStatusResponse{
	// 	WorkspacePurgeStatusResponse: armoperationalinsights.WorkspacePurgeStatusResponse{
	// 		Status: to.Ptr(armoperationalinsights.PurgeStateCompleted),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to gets status of an ongoing purge operation.
 *
 * @summary gets status of an ongoing purge operation.
 * x-ms-original-file: 2025-07-01/WorkspacesPurgeOperation.json
 */
async function workspacePurgeOperation() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.workspacePurge.getPurgeStatus(
    "OIAutoRest5123",
    "aztest5048",
    "purge-970318e7-b859-4edb-8903-83b1b54d0b74",
  );
  console.log(result);
}

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

応答のサンプル

状態コード:

200

{
  "status": "completed"
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PurgeState	要求された ID で表される操作の状態。
WorkspacePurgeStatusResponse	特定のパージ操作のステータスを含む応答。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

PurgeState

列挙

要求された ID で表される操作の状態。

値	説明
pending	pending
completed	完了

WorkspacePurgeStatusResponse

Object

特定のパージ操作のステータスを含む応答。

名前	型	説明
status	PurgeState	要求された ID で表される操作の状態。