Jobs - Get

Riferimento

Service:: Data Protection

API Version:: 2023-01-01

Ottiene un processo con ID in un insieme di credenziali di backup

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}?api-version=2023-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
jobId	path	True	string	ID processo. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-0000-000000000000).
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
vaultName	path	True	string	Nome dell'insieme di credenziali di backup.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	AzureBackupJobResource	OK
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente.

Esempio

Get Job

Sample Request

GET https://management.azure.com/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae?api-version=2023-01-01

/** Samples for Jobs Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
     */
    /**
     * Sample code: Get Job.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void getJob(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .jobs()
            .getWithResponse(
                "BugBash1",
                "BugBashVaultForCCYv11",
                "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
                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

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python get_job.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 = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="62b829ee-7936-40c9-a1c9-47a93f9f3965",
    )

    response = client.jobs.get(
        resource_group_name="BugBash1",
        vault_name="BugBashVaultForCCYv11",
        job_id="3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
    )
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.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

package armdataprotection_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
func ExampleJobsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewJobsClient().Get(ctx, "BugBash1", "BugBashVaultForCCYv11", "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", 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.AzureBackupJobResource = armdataprotection.AzureBackupJobResource{
	// 	Name: to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 	ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 	Properties: &armdataprotection.AzureBackupJob{
	// 		ActivityID: to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
	// 		BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb2"),
	// 		BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e"),
	// 		DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2"),
	// 		DataSourceLocation: to.Ptr("centraluseuap"),
	// 		DataSourceName: to.Ptr("bugbashdb2"),
	// 		DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 		DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 		Duration: to.Ptr("00:00:00"),
	// 		ExtendedInfo: &armdataprotection.JobExtendedInfo{
	// 			AdditionalDetails: map[string]*string{
	// 				"PolicyRuleName": to.Ptr("BackupWeekly"),
	// 				"RetentionTag": to.Ptr("Default"),
	// 				"TaskId": to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
	// 			},
	// 			SubTasks: []*armdataprotection.JobSubTask{
	// 				{
	// 					TaskID: to.Ptr[int32](1),
	// 					TaskName: to.Ptr("Trigger Backup"),
	// 					TaskStatus: to.Ptr("Started"),
	// 			}},
	// 		},
	// 		IsUserTriggered: to.Ptr(false),
	// 		Operation: to.Ptr("Backup"),
	// 		OperationCategory: to.Ptr("Backup"),
	// 		PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy"),
	// 		PolicyName: to.Ptr("jakavetdailypolicy"),
	// 		ProgressEnabled: to.Ptr(false),
	// 		SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 		SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T03:00:03.7604146Z"); return t}()),
	// 		Status: to.Ptr("Started"),
	// 		SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 		SupportedActions: []*string{
	// 		},
	// 		VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets a job with id in a backup vault
 *
 * @summary Gets a job with id in a backup vault
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
 */
async function getJob() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "62b829ee-7936-40c9-a1c9-47a93f9f3965";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "BugBash1";
  const vaultName = "BugBashVaultForCCYv11";
  const jobId = "3c60cb49-63e8-4b21-b9bd-26277b3fdfae";
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.jobs.get(resourceGroupName, vaultName, jobId);
  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

Sample Response

Status code:: 200

{
  "properties": {
    "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
    "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
    "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
    "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
    "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
    "vaultName": "BugBashVaultForCCYv11",
    "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
    "policyName": "jakavetdailypolicy",
    "sourceResourceGroup": "DppPostgresTestingCcy",
    "dataSourceSetName": "mabtestingccybasicv11",
    "dataSourceName": "bugbashdb2",
    "progressEnabled": false,
    "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
    "startTime": "2021-03-17T03:00:03.7604146Z",
    "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
    "operationCategory": "Backup",
    "operation": "Backup",
    "status": "Started",
    "isUserTriggered": false,
    "supportedActions": [],
    "duration": "00:00:00",
    "dataSourceLocation": "centraluseuap",
    "extendedInfo": {
      "subTasks": [
        {
          "taskId": 1,
          "taskName": "Trigger Backup",
          "taskStatus": "Started"
        }
      ],
      "additionalDetails": {
        "RetentionTag": "Default",
        "PolicyRuleName": "BackupWeekly",
        "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"
      }
    }
  },
  "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
}

Definizioni

Nome	Descrizione
AzureBackupJob	Classe di processo AzureBackup
AzureBackupJobResource	Classe di risorse processo AzureBackup
CloudError	CloudError
createdByType	Tipo di identità che ha creato la risorsa.
Error	Risposta all'errore di gestione delle risorse.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
InnerError	InnerError
JobExtendedInfo	Informazioni estese sul processo
JobSubTask	Dettagli dell'attività secondaria del processo
RestoreJobRecoveryPointDetails
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserFacingError	Oggetto errore usato dai livelli che hanno accesso al contenuto localizzato e propagano tale oggetto all'utente

AzureBackupJob

Classe di processo AzureBackup

Nome	Tipo	Descrizione
activityID	string	ID attività processo
backupInstanceFriendlyName	string	Nome dell'istanza di backup
backupInstanceId	string	ID ARM dell'istanza di backup
dataSourceId	string	ID ARM dell'origine dati
dataSourceLocation	string	Posizione dell'origine dati
dataSourceName	string	Nome descrittivo dell'origine dati
dataSourceSetName	string	Nome del set di origini dati dell'origine dati
dataSourceType	string	Tipo di origine dati
destinationDataStoreName	string
duration	string	Tempo totale di esecuzione del processo. Formato ISO 8601.
endTime	string	EndTime del processo (in formato UTC)
errorDetails	UserFacingError[]	Elenco, che illustra in dettaglio gli errori correlati al processo
etag	string
extendedInfo	JobExtendedInfo	Informazioni estese sul processo
isUserTriggered	boolean	Indica se il processo è adhoc(true) o scheduled(false)
operation	string	Indica il tipo di processo, ad esempio Backup:full/log/diff ; Restore:ALR/OLR; Suddivisione in livelli:Backup/Archivio ; Gestione:ConfigureProtection/UnConfigure
operationCategory	string	Indica il tipo di processo, ad esempio backup/ripristino/suddivisione in livelli/gestione
policyId	string	ID ARM dei criteri
policyName	string	Nome del criterio
progressEnabled	boolean	Indica se lo stato di avanzamento è abilitato per il processo
progressUrl	string	URL che contiene lo stato del processo
restoreType	string	Indica il sottotipo di operazione, ad esempio nel caso di Ripristino, può essere ALR/OLR
sourceDataStoreName	string
sourceResourceGroup	string	Nome gruppo di risorse dell'origine dati
sourceSubscriptionID	string	SubscriptionId corrispondente all'origine dati
startTime	string	StartTime del processo (in FORMATO UTC)
status	string	Stato del processo, ad esempio InProgress/Success/Failed/Cancelled/SuccessWithWarning
subscriptionId	string	ID sottoscrizione dell'insieme di credenziali di backup corrispondente
supportedActions	string[]	Elenco delle azioni supportate
vaultName	string	Nome dell'insieme di credenziali

AzureBackupJobResource

Classe di risorse processo AzureBackup

Nome	Tipo	Descrizione
id	string	ID risorsa rappresenta il percorso completo della risorsa.
name	string	Nome della risorsa associato alla risorsa.
properties	AzureBackupJob	Proprietà di AzureBackupJobResource
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo di risorsa rappresenta il percorso completo del modulo Spazio dei nomi/ResourceType/ResourceType/...

CloudError

Nome	Tipo	Descrizione
error	Error	Risposta all'errore di gestione delle risorse.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Risposta all'errore di gestione delle risorse.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	Error[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

InnerError

Nome	Tipo	Descrizione
additionalInfo	object	Qualsiasi coppia chiave valore che può essere fornita al client per informazioni dettagliate aggiuntive.
code	string	Codice univoco per questo errore
embeddedInnerError	InnerError	InnerError Errore interno figlio, per consentire l'annidamento.

JobExtendedInfo

Informazioni estese sul processo

Nome	Tipo	Descrizione
additionalDetails	object	Dettagli aggiuntivi del processo
backupInstanceState	string	Stato dell'istanza di backup
dataTransferredInBytes	number	Numero di byte trasferiti
recoveryDestination	string	Destinazione in cui viene eseguito il ripristino
sourceRecoverPoint	RestoreJobRecoveryPointDetails	Dettagli del punto di ripristino di origine
subTasks	JobSubTask[]	Elenco di attività secondarie del processo
targetRecoverPoint	RestoreJobRecoveryPointDetails	Dettagli del punto di ripristino di destinazione

JobSubTask

Dettagli dell'attività secondaria del processo

Nome	Tipo	Descrizione
additionalDetails	object	Dettagli aggiuntivi delle attività secondarie
taskId	integer	ID attività dell'attività secondaria
taskName	string	Nome dell'attività secondaria
taskProgress	string	Stato dell'attività secondaria
taskStatus	string	Stato dell'attività secondaria

RestoreJobRecoveryPointDetails

Nome	Tipo	Descrizione
recoveryPointID	string
recoveryPointTime	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserFacingError

Oggetto errore usato dai livelli che hanno accesso al contenuto localizzato e propagano tale oggetto all'utente

Nome	Tipo	Descrizione
code	string	Codice univoco per questo errore
details	UserFacingError[]	Errori correlati aggiuntivi
innerError	InnerError	InnerError Errore interno
isRetryable	boolean	Indica se l'operazione sarà riprovabile o meno
isUserError	boolean	Indica se l'operazione è dovuta a un errore dell'utente o di un servizio
message	string
properties	object	Qualsiasi coppia chiave-valore che può essere inserita all'interno dell'oggetto error
recommendedAction	string[]	RecommendedAction localizzato.
target	string	Destinazione dell'errore.

Jobs - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

Get Job

Sample Request

Sample Response

Definizioni

AzureBackupJob

AzureBackupJobResource

CloudError

createdByType

Error

ErrorAdditionalInfo

InnerError

JobExtendedInfo

JobSubTask

RestoreJobRecoveryPointDetails

systemData

UserFacingError

Risorse aggiuntive