Workspace Purge - Get Purge Status

Serviço:: Log Analytics

Versão da API:: 2025-02-01

Obtém o status de uma operação de limpeza em andamento.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
purgeId	path	True	string	Em uma solicitação de status de limpeza, esse é o Id da operação cujo status é retornado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	WorkspacePurgeStatusResponse	Retorna o status da operação de limpeza no corpo da resposta. Ex.: em execução, concluído.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

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

Resposta da amostra

Código de estado:: 200

{
  "status": "completed"
}

Definições

Name	Description
PurgeState	Status da operação representado pelo ID solicitado.
WorkspacePurgeStatusResponse	Resposta contendo o status de uma operação de limpeza específica.

PurgeState

Enumeração

Status da operação representado pelo ID solicitado.

Valor	Description
pending
completed

WorkspacePurgeStatusResponse

Object

Resposta contendo o status de uma operação de limpeza específica.

Name	Tipo	Description
status	PurgeState	Status da operação representado pelo ID solicitado.

Partilhar via