Skip to main content

job

Creates, updates, deletes, gets or lists a job resource.

Overview​

Namejob
TypeResource
Idazure.recovery_services_data_replication.job

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
activityIdstringGets or sets the job activity id.
allowedActionsarrayGets or sets the list of allowed actions on the job.
customPropertiesobjectJob model custom properties. Required.
displayNamestringGets or sets the friendly display name.
endTimestring (date-time)Gets or sets the end time.
errorsarrayGets or sets the list of errors.
objectIdstringGets or sets the affected object Id.
objectInternalIdstringGets or sets the affected object internal Id.
objectInternalNamestringGets or sets the affected object internal name.
objectNamestringGets or sets the affected object name.
objectTypestringGets or sets the object type. Known values are: "AvsDiskPool", "FabricAgent", "Fabric", "Policy", "ProtectedItem", "RecoveryPlan", "ReplicationExtension", and "Vault". (AvsDiskPool, FabricAgent, Fabric, Policy, ProtectedItem, RecoveryPlan, ReplicationExtension, Vault)
provisioningStatestringGets or sets the provisioning state of the job. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
replicationProviderIdstringGets or sets the replication provider.
sourceFabricProviderIdstringGets or sets the source fabric provider.
startTimestring (date-time)Gets or sets the start time.
statestringGets or sets the job state. Known values are: "Pending", "Started", "Cancelling", "Succeeded", "Failed", "Cancelled", "CompletedWithInformation", "CompletedWithWarnings", and "CompletedWithErrors". (Pending, Started, Cancelling, Succeeded, Failed, Cancelled, CompletedWithInformation, CompletedWithWarnings, CompletedWithErrors)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
targetFabricProviderIdstringGets or sets the target fabric provider.
tasksarrayGets or sets the list of tasks.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, vault_name, job_name, subscription_idGets the details of the job.
listselectresource_group_name, vault_name, subscription_idodataOptions, continuationToken, pageSizeGets the list of jobs in the given vault.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
job_namestringThe job name. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
vault_namestringThe vault name. Required.
continuationTokenstringContinuation token. Default value is None.
odataOptionsstringOData options. Default value is None.
pageSizeintegerPage size. Default value is None.

SELECT examples​

Gets the details of the job.

SELECT
id,
name,
activityId,
allowedActions,
customProperties,
displayName,
endTime,
errors,
objectId,
objectInternalId,
objectInternalName,
objectName,
objectType,
provisioningState,
replicationProviderId,
sourceFabricProviderId,
startTime,
state,
systemData,
targetFabricProviderId,
tasks,
type
FROM azure.recovery_services_data_replication.job
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;