你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 minLength: 1	目标订阅的 ID。
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_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

WorkspacePurgeOperation

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-07-01

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="00000000-0000-0000-0000-00000000000",
    )

    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: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/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

示例响应

状态代码:: 200

{
  "status": "completed"
}

定义

名称	说明
PurgeState	请求的 ID 表示的作的状态。
WorkspacePurgeStatusResponse	包含特定清除作的状态的响应。

PurgeState

枚举

请求的 ID 表示的作的状态。

值	说明
pending
completed

WorkspacePurgeStatusResponse

对象

包含特定清除作的状态的响应。

名称	类型	说明
status	PurgeState	请求的 ID 表示的作的状态。

通过