Workflow Operation Status - Get

Szolgáltatás:

Data Replication

API-verzió:

2021-02-16-preview

Lekéri a feladat (munkafolyamat) műveletének állapotát.
Nyomon követi a feladat aszinkron műveletének eredményeit.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}/operations/{operationId}?api-version=2021-02-16-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
jobName	path	True	string pattern: ^[a-zA-Z0-9]*$	A feladat (munkafolyamat) neve.
operationId	path	True	string minLength: 1	Egy folyamatban lévő aszinkron művelet azonosítója.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
vaultName	path	True	string pattern: ^[a-zA-Z0-9]*$	A tároló neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	OperationStatus	Siker
Other Status Codes	ErrorResponse	Hiba

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

WorkflowOperationStatus_Get

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/930CEC23-4430-4513-B855-DBA237E2F3BF/resourceGroups/rgrecoveryservicesdatareplication/providers/Microsoft.DataReplication/replicationVaults/4/jobs/ZGH4y/operations/wdqcxc?api-version=2021-02-16-preview

Java

/**
 * Samples for WorkflowOperationStatus Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-
     * preview/examples/WorkflowOperationStatus_Get.json
     */
    /**
     * Sample code: WorkflowOperationStatus_Get.
     * 
     * @param manager Entry point to RecoveryServicesDataReplicationManager.
     */
    public static void workflowOperationStatusGet(
        com.azure.resourcemanager.recoveryservicesdatareplication.RecoveryServicesDataReplicationManager manager) {
        manager.workflowOperationStatus().getWithResponse("rgrecoveryservicesdatareplication", "4", "ZGH4y", "wdqcxc",
            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.recoveryservicesdatareplication import RecoveryServicesDataReplicationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesdatareplication
# USAGE
    python workflow_operation_status_get.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 = RecoveryServicesDataReplicationMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="930CEC23-4430-4513-B855-DBA237E2F3BF",
    )

    response = client.workflow_operation_status.get(
        resource_group_name="rgrecoveryservicesdatareplication",
        vault_name="4",
        job_name="ZGH4y",
        operation_id="wdqcxc",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/WorkflowOperationStatus_Get.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 armrecoveryservicesdatareplication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservicesdatareplication/armrecoveryservicesdatareplication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3066a973f4baf2e2bf072a013b585a820bb10146/specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/WorkflowOperationStatus_Get.json
func ExampleWorkflowOperationStatusClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesdatareplication.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkflowOperationStatusClient().Get(ctx, "rgrecoveryservicesdatareplication", "4", "ZGH4y", "wdqcxc", 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.OperationStatus = armrecoveryservicesdatareplication.OperationStatus{
	// 	Name: to.Ptr("wzdasptnwlxgobklayoqapjcgcf"),
	// 	EndTime: to.Ptr("nauyrfh"),
	// 	ID: to.Ptr("sf"),
	// 	StartTime: to.Ptr("xuzwmfrhluafmwwsmzqxsytyehsh"),
	// 	Status: to.Ptr("plbnngzfppdram"),
	// }
}

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

Mintaválasz

Állapotkód:

200

{
  "id": "sf",
  "name": "wzdasptnwlxgobklayoqapjcgcf",
  "status": "plbnngzfppdram",
  "startTime": "xuzwmfrhluafmwwsmzqxsytyehsh",
  "endTime": "nauyrfh"
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
OperationStatus	Meghatározza a művelet állapotát.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

OperationStatus

Objektum

Meghatározza a művelet állapotát.

Name	Típus	Description
endTime	string	Lekéri vagy beállítja a befejezési időt.
id	string	Lekéri vagy beállítja az azonosítót.
name	string	Lekéri vagy beállítja a művelet nevét.
startTime	string	Lekéri vagy beállítja a kezdési időpontot.
status	string	Lekéri vagy beállítja a művelet állapotát. Az ARM azt várja, hogy a terminál állapota a Sikeres/Sikertelen/Megszakított állapotú lesz. Minden más érték azt jelenti, hogy a művelet még fut.