replication_jobs

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

Overview

Name	replication_jobs
Type	Resource
Id	azure.recovery_services_site_recovery.replication_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, jobName	api-version	Get the details of an Azure Site Recovery job.
list	select	resourceName, resourceGroupName, subscriptionId	api-version, $filter	Gets the list of Azure Site Recovery Jobs for the vault.
cancel	exec	resourceName, resourceGroupName, subscriptionId, jobName	api-version	The operation to cancel an Azure Site Recovery job.
restart	exec	resourceName, resourceGroupName, subscriptionId, jobName	api-version	The operation to restart an Azure Site Recovery job.
resume	exec	resourceName, resourceGroupName, subscriptionId, jobName	api-version	The operation to resume an Azure Site Recovery job.
export	exec	resourceName, resourceGroupName, subscriptionId	api-version	The operation to export the details of the Azure Site Recovery jobs of the 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.

Name	Datatype	Description
jobName	string	Job identifier.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
$filter	string	OData filter options.
api-version	string	Client Api Version.

SELECT examples

get

Get the details of an Azure Site Recovery job.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_jobs
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND jobName = '{{ jobName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Gets the list of Azure Site Recovery Jobs for the vault.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_jobs
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

cancel

The operation to cancel an Azure Site Recovery job.

EXEC azure.recovery_services_site_recovery.replication_jobs.cancel 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@jobName='{{ jobName }}' --required, 
@api-version='{{ api-version }}'
;

restart

The operation to restart an Azure Site Recovery job.

EXEC azure.recovery_services_site_recovery.replication_jobs.restart 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@jobName='{{ jobName }}' --required, 
@api-version='{{ api-version }}'
;

resume

The operation to resume an Azure Site Recovery job.

EXEC azure.recovery_services_site_recovery.replication_jobs.resume 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@jobName='{{ jobName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

export

The operation to export the details of the Azure Site Recovery jobs of the vault.

EXEC azure.recovery_services_site_recovery.replication_jobs.export 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"startTime": "{{ startTime }}", 
"endTime": "{{ endTime }}", 
"fabricId": "{{ fabricId }}", 
"affectedObjectTypes": "{{ affectedObjectTypes }}", 
"jobStatus": "{{ jobStatus }}", 
"jobOutputType": "{{ jobOutputType }}", 
"jobName": "{{ jobName }}", 
"timezoneOffset": {{ timezoneOffset }}
}'
;