Jobs - Get

Başvuru

Service:: Data Protection

API Version:: 2023-01-01

Yedekleme kasasında kimliği olan bir iş alır

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
jobId	path	True	string	İş Kimliği. Bu GUID biçimli bir dizedir (örneğin, 000000000-0000-0000-0000-00000000000000).
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string uuid	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
vaultName	path	True	string	Yedekleme kasasının adı.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	AzureBackupJobResource	Tamam
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme.

Örnekler

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"
}

Tanımlar

Name	Description
AzureBackupJob	AzureBackup İş Sınıfı
AzureBackupJobResource	AzureBackup İşi Kaynak Sınıfı
CloudError	CloudError
createdByType	Kaynağı oluşturan kimliğin türü.
Error	Kaynak yönetimi hata yanıtı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
InnerError	InnerError
JobExtendedInfo	İş hakkında Genişletilmiş Bilgi
JobSubTask	İşin Alt Görevinin Ayrıntıları
RestoreJobRecoveryPointDetails
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserFacingError	Yerelleştirilmiş içeriğe erişimi olan ve bunu kullanıcıya yayarak katmanlar tarafından kullanılan hata nesnesi

AzureBackupJob

AzureBackup İş Sınıfı

Name	Tür	Description
activityID	string	İş Etkinlik Kimliği
backupInstanceFriendlyName	string	Yedekleme Örneğinin Adı
backupInstanceId	string	Yedekleme Örneğinin ARM Kimliği
dataSourceId	string	DataSource'un ARM Kimliği
dataSourceLocation	string	DataSource'un konumu
dataSourceName	string	DataSource'un Kullanıcı Dostu Adı
dataSourceSetName	string	DataSource'un Veri Kaynağı Kümesi Adı
dataSourceType	string	DataSource Türü
destinationDataStoreName	string
duration	string	İşin toplam çalışma süresi. ISO 8601 biçimi.
endTime	string	İşin EndTime'ı (UTC'de)
errorDetails	UserFacingError[]	İşle ilgili hataların ayrıntılarını içeren liste
etag	string
extendedInfo	JobExtendedInfo	İş hakkında Genişletilmiş Bilgi
isUserTriggered	boolean	İşin geçici (doğru) veya zamanlanmış (yanlış) olduğunu belirtir
operation	string	İş türünü gösterir; örneğin Backup:full/log/diff; Geri Yükleme:ALR/OLR; Katmanlama:Yedekleme/Arşiv ; Yönetim:ConfigureProtection/UnConfigure
operationCategory	string	İşin türünü gösterir; örneğin Yedekleme/Geri Yükleme/Katmanlama/Yönetim
policyId	string	İlkenin ARM Kimliği
policyName	string	İlkenin adı
progressEnabled	boolean	İlerleme durumunun iş için etkinleştirilip etkinleştirilmediği gösterilir
progressUrl	string	İşin ilerleme durumunu içeren URL
restoreType	string	İşlemin alt türünü gösterir; örneğin Geri yükleme durumunda ALR/OLR olabilir
sourceDataStoreName	string
sourceResourceGroup	string	Veri Kaynağının Kaynak Grubu Adı
sourceSubscriptionID	string	DataSource'a karşılık gelen SubscriptionId
startTime	string	İşin StartTime'ı (UTC'de)
status	string	İşin Durumu: InProgress/Success/Failed/Cancelled/SuccessWithWarning
subscriptionId	string	İlgili yedekleme kasasının Abonelik Kimliği
supportedActions	string[]	Desteklenen eylemlerin listesi
vaultName	string	Kasanın adı

AzureBackupJobResource

AzureBackup İşi Kaynak Sınıfı

Name	Tür	Description
id	string	Kaynak Kimliği, kaynağın tam yolunu temsil eder.
name	string	Kaynakla ilişkili kaynak adı.
properties	AzureBackupJob	AzureBackupJobResource özellikleri
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
type	string	Kaynak türü Ad Alanı/ResourceType/ResourceType/... formunun tam yolunu temsil eder.

CloudError

Name	Tür	Description
error	Error	Kaynak yönetimi hata yanıtı.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Kaynak yönetimi hata yanıtı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	Error[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

InnerError

Name	Tür	Description
additionalInfo	object	ek ayrıntılı bilgi için istemciye sağlanabilir herhangi bir Anahtar değer çifti.
code	string	Bu hata için benzersiz kod
embeddedInnerError	InnerError	InnerError İç İçe Yerleştirmeye izin vermek için Alt İç Hata.

JobExtendedInfo

İş hakkında Genişletilmiş Bilgi

Name	Tür	Description
additionalDetails	object	İşin Ek Ayrıntıları
backupInstanceState	string	Yedekleme Örneğinin Durumu
dataTransferredInBytes	number	Aktarılan bayt sayısı
recoveryDestination	string	Geri yüklemenin yapıldığı hedef
sourceRecoverPoint	RestoreJobRecoveryPointDetails	Kaynak Kurtarma Noktası Ayrıntıları
subTasks	JobSubTask[]	İşin Alt Görevleri Listesi
targetRecoverPoint	RestoreJobRecoveryPointDetails	Hedef Kurtarma Noktasının Ayrıntıları

JobSubTask

İşin Alt Görevinin Ayrıntıları

Name	Tür	Description
additionalDetails	object	Alt Görevlerin ek ayrıntıları
taskId	integer	Alt Görevin Görev Kimliği
taskName	string	Alt Görevin Adı
taskProgress	string	Alt Görevin İlerleme durumu
taskStatus	string	Alt Görevin Durumu

RestoreJobRecoveryPointDetails

Name	Tür	Description
recoveryPointID	string
recoveryPointTime	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UserFacingError

Yerelleştirilmiş içeriğe erişimi olan ve bunu kullanıcıya yayarak katmanlar tarafından kullanılan hata nesnesi

Name	Tür	Description
code	string	Bu hata için benzersiz kod
details	UserFacingError[]	ek ilgili hatalar
innerError	InnerError	InnerError İç Hata
isRetryable	boolean	İşlemin yeniden denenip denenmeyeceğini
isUserError	boolean	İşlemin bir kullanıcı hatasından mı yoksa hizmet hatasından mı kaynaklandığından
message	string
properties	object	Hata nesnesinin içine eklenebilen tüm anahtar değer çiftleri
recommendedAction	string[]	RecommendedAction localized.
target	string	Hatanın hedefi.

Aracılığıyla paylaş

Jobs - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Get Job

Sample Request

Sample Response

Tanımlar

AzureBackupJob

AzureBackupJobResource

CloudError

createdByType

Error

ErrorAdditionalInfo

InnerError

JobExtendedInfo

JobSubTask

RestoreJobRecoveryPointDetails

systemData

UserFacingError

Ek kaynaklar