jobs

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

Overview

Name	jobs
Type	Resource
Id	azure_extras.storage_import_export.jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Specifies the resource identifier of the job.
name	string	Specifies the name of the job.
backupDriveManifest	boolean	Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested	boolean	Indicates whether a request has been submitted to cancel the job.
deliveryPackage	object	Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath	string	The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList	array	List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.
encryptionKey	object	Contains information about the encryption key.
export	object	A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
identity	object	Specifies the job identity details.
incompleteBlobListUri	string	A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.
jobType	string	The type of job.
location	string	Specifies the Azure location where the job is created.
logLevel	string	Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete	integer	Overall percentage completed for the job.
provisioningState	string	Specifies the provisioning state of the job.
returnAddress	object	Specifies the return address information for the job.
returnPackage	object	Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping	object	Specifies the return carrier and customer's account with the carrier.
shippingInformation	object	Contains information about the Microsoft datacenter to which the drives should be shipped.
state	string	Current state of the job.
storageAccountId	string	The resource identifier of the storage account where data will be imported to or exported from.
systemData	object	SystemData of ImportExport Jobs.
tags	object	Specifies the tags that are assigned to the job.
type	string	Specifies the type of the job resource.

list_by_resource_group

Name	Datatype	Description
id	string	Specifies the resource identifier of the job.
name	string	Specifies the name of the job.
backupDriveManifest	boolean	Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested	boolean	Indicates whether a request has been submitted to cancel the job.
deliveryPackage	object	Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath	string	The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList	array	List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.
encryptionKey	object	Contains information about the encryption key.
export	object	A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
identity	object	Specifies the job identity details.
incompleteBlobListUri	string	A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.
jobType	string	The type of job.
location	string	Specifies the Azure location where the job is created.
logLevel	string	Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete	integer	Overall percentage completed for the job.
provisioningState	string	Specifies the provisioning state of the job.
returnAddress	object	Specifies the return address information for the job.
returnPackage	object	Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping	object	Specifies the return carrier and customer's account with the carrier.
shippingInformation	object	Contains information about the Microsoft datacenter to which the drives should be shipped.
state	string	Current state of the job.
storageAccountId	string	The resource identifier of the storage account where data will be imported to or exported from.
systemData	object	SystemData of ImportExport Jobs.
tags	object	Specifies the tags that are assigned to the job.
type	string	Specifies the type of the job resource.

list_by_subscription

Name	Datatype	Description
id	string	Specifies the resource identifier of the job.
name	string	Specifies the name of the job.
backupDriveManifest	boolean	Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested	boolean	Indicates whether a request has been submitted to cancel the job.
deliveryPackage	object	Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath	string	The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList	array	List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.
encryptionKey	object	Contains information about the encryption key.
export	object	A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
identity	object	Specifies the job identity details.
incompleteBlobListUri	string	A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.
jobType	string	The type of job.
location	string	Specifies the Azure location where the job is created.
logLevel	string	Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete	integer	Overall percentage completed for the job.
provisioningState	string	Specifies the provisioning state of the job.
returnAddress	object	Specifies the return address information for the job.
returnPackage	object	Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping	object	Specifies the return carrier and customer's account with the carrier.
shippingInformation	object	Contains information about the Microsoft datacenter to which the drives should be shipped.
state	string	Current state of the job.
storageAccountId	string	The resource identifier of the storage account where data will be imported to or exported from.
systemData	object	SystemData of ImportExport Jobs.
tags	object	Specifies the tags that are assigned to the job.
type	string	Specifies the type of the job resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	job_name, resource_group_name, subscription_id	Accept-Language	Gets information about an existing job.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $filter, Accept-Language	Returns all active and completed jobs in a resource group.
list_by_subscription	select	subscription_id	$top, $filter, Accept-Language	Returns all active and completed jobs in a subscription.
create	insert	job_name, resource_group_name, subscription_id	x-ms-client-tenant-id, Accept-Language	Creates a new job or updates an existing job in the specified subscription.
update	update	job_name, resource_group_name, subscription_id	Accept-Language	Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.
delete	delete	job_name, resource_group_name, subscription_id	Accept-Language	Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

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
job_name	string	The name of the import/export job. Required.
resource_group_name	string	The resource group name uniquely identifies the resource group within the user subscription. Required.
subscription_id	string
$filter	string	Can be used to restrict the results to certain conditions. Default value is None.
$top	integer	An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. Default value is None.
Accept-Language	string
x-ms-client-tenant-id	string	The tenant ID of the client making the request. Default value is None.

SELECT examples

get

Gets information about an existing job.

SELECT
id,
name,
backupDriveManifest,
cancelRequested,
deliveryPackage,
diagnosticsPath,
driveList,
encryptionKey,
export,
identity,
incompleteBlobListUri,
jobType,
location,
logLevel,
percentComplete,
provisioningState,
returnAddress,
returnPackage,
returnShipping,
shippingInformation,
state,
storageAccountId,
systemData,
tags,
type
FROM azure_extras.storage_import_export.jobs
WHERE job_name = '{{ job_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND Accept-Language = '{{ Accept-Language }}'
;

list_by_resource_group

Returns all active and completed jobs in a resource group.

SELECT
id,
name,
backupDriveManifest,
cancelRequested,
deliveryPackage,
diagnosticsPath,
driveList,
encryptionKey,
export,
identity,
incompleteBlobListUri,
jobType,
location,
logLevel,
percentComplete,
provisioningState,
returnAddress,
returnPackage,
returnShipping,
shippingInformation,
state,
storageAccountId,
systemData,
tags,
type
FROM azure_extras.storage_import_export.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
AND Accept-Language = '{{ Accept-Language }}'
;

list_by_subscription

Returns all active and completed jobs in a subscription.

SELECT
id,
name,
backupDriveManifest,
cancelRequested,
deliveryPackage,
diagnosticsPath,
driveList,
encryptionKey,
export,
identity,
incompleteBlobListUri,
jobType,
location,
logLevel,
percentComplete,
provisioningState,
returnAddress,
returnPackage,
returnShipping,
shippingInformation,
state,
storageAccountId,
systemData,
tags,
type
FROM azure_extras.storage_import_export.jobs
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
AND Accept-Language = '{{ Accept-Language }}'
;

INSERT examples

create

Creates a new job or updates an existing job in the specified subscription.

INSERT INTO azure_extras.storage_import_export.jobs (
location,
tags,
properties,
job_name,
resource_group_name,
subscription_id,
x-ms-client-tenant-id,
Accept-Language
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ job_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}',
'{{ x-ms-client-tenant-id }}',
'{{ Accept-Language }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: jobs
props:
  - name: job_name
    value: "{{ job_name }}"
    description: Required parameter for the jobs resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the jobs resource.
  - name: location
    value: "{{ location }}"
    description: |
      Specifies the supported Azure location where the job should be created.
  - name: tags
    value: "{{ tags }}"
    description: |
      Specifies the tags that will be assigned to the job.
  - name: properties
    description: |
      Specifies the job properties.
    value:
      storageAccountId: "{{ storageAccountId }}"
      jobType: "{{ jobType }}"
      returnAddress:
        recipientName: "{{ recipientName }}"
        streetAddress1: "{{ streetAddress1 }}"
        streetAddress2: "{{ streetAddress2 }}"
        city: "{{ city }}"
        stateOrProvince: "{{ stateOrProvince }}"
        postalCode: "{{ postalCode }}"
        countryOrRegion: "{{ countryOrRegion }}"
        phone: "{{ phone }}"
        email: "{{ email }}"
      returnShipping:
        carrierName: "{{ carrierName }}"
        carrierAccountNumber: "{{ carrierAccountNumber }}"
      shippingInformation:
        recipientName: "{{ recipientName }}"
        streetAddress1: "{{ streetAddress1 }}"
        streetAddress2: "{{ streetAddress2 }}"
        city: "{{ city }}"
        stateOrProvince: "{{ stateOrProvince }}"
        postalCode: "{{ postalCode }}"
        countryOrRegion: "{{ countryOrRegion }}"
        phone: "{{ phone }}"
        additionalInformation: "{{ additionalInformation }}"
      deliveryPackage:
        carrierName: "{{ carrierName }}"
        trackingNumber: "{{ trackingNumber }}"
        driveCount: {{ driveCount }}
        shipDate: "{{ shipDate }}"
      returnPackage:
        carrierName: "{{ carrierName }}"
        trackingNumber: "{{ trackingNumber }}"
        driveCount: {{ driveCount }}
        shipDate: "{{ shipDate }}"
      diagnosticsPath: "{{ diagnosticsPath }}"
      logLevel: "{{ logLevel }}"
      backupDriveManifest: {{ backupDriveManifest }}
      state: "{{ state }}"
      cancelRequested: {{ cancelRequested }}
      percentComplete: {{ percentComplete }}
      incompleteBlobListUri: "{{ incompleteBlobListUri }}"
      driveList:
        - driveId: "{{ driveId }}"
          bitLockerKey: "{{ bitLockerKey }}"
          manifestFile: "{{ manifestFile }}"
          manifestHash: "{{ manifestHash }}"
          driveHeaderHash: "{{ driveHeaderHash }}"
          state: "{{ state }}"
          copyStatus: "{{ copyStatus }}"
          percentComplete: {{ percentComplete }}
          verboseLogUri: "{{ verboseLogUri }}"
          errorLogUri: "{{ errorLogUri }}"
          manifestUri: "{{ manifestUri }}"
          bytesSucceeded: {{ bytesSucceeded }}
      export:
        blobListBlobPath: "{{ blobListBlobPath }}"
        blobList:
          blobPath:
            - "{{ blobPath }}"
          blobPathPrefix:
            - "{{ blobPathPrefix }}"
      provisioningState: "{{ provisioningState }}"
      encryptionKey:
        kekType: "{{ kekType }}"
        kekUrl: "{{ kekUrl }}"
        kekVaultResourceID: "{{ kekVaultResourceID }}"
  - name: x-ms-client-tenant-id
    value: "{{ x-ms-client-tenant-id }}"
    description: The tenant ID of the client making the request. Default value is None.
    description: The tenant ID of the client making the request. Default value is None.
  - name: Accept-Language
    value: "{{ Accept-Language }}"

UPDATE examples

update

Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.

UPDATE azure_extras.storage_import_export.jobs
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
job_name = '{{ job_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND Accept-Language = '{{ Accept-Language}}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

DELETE FROM azure_extras.storage_import_export.jobs
WHERE job_name = '{{ job_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND Accept-Language = '{{ Accept-Language }}'
;