jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.storage_import_export.jobs

Fields

vw_jobs

Name	Datatype	Description
id	text	Specifies the resource identifier of the job.
name	text	Specifies the name of the job.
backup_drive_manifest	text	field from the properties object
cancel_requested	text	field from the properties object
delivery_package	text	field from the properties object
diagnostics_path	text	field from the properties object
drive_list	text	field from the properties object
encryption_key	text	field from the properties object
export	text	field from the properties object
identity	text	Specifies the identity properties.
incomplete_blob_list_uri	text	field from the properties object
jobName	text	field from the properties object
job_type	text	field from the properties object
location	text	Specifies the Azure location where the job is created.
log_level	text	field from the properties object
percent_complete	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
return_address	text	field from the properties object
return_package	text	field from the properties object
return_shipping	text	field from the properties object
shipping_information	text	field from the properties object
state	text	field from the properties object
storage_account_id	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Specifies the tags that are assigned to the job.
type	text	Specifies the type of the job resource.

jobs

Name	Datatype	Description
id	string	Specifies the resource identifier of the job.
name	string	Specifies the name of the job.
identity	object	Specifies the identity properties.
location	string	Specifies the Azure location where the job is created.
properties	object	Specifies the job properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Specifies the tags that are assigned to the job.
type	string	Specifies the type of the job resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	jobName, resourceGroupName, subscriptionId	Gets information about an existing job.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns all active and completed jobs in a resource group.
list_by_subscription	SELECT	subscriptionId	Returns all active and completed jobs in a subscription.
create	INSERT	jobName, resourceGroupName, subscriptionId	Creates a new job or updates an existing job in the specified subscription.
delete	DELETE	jobName, resourceGroupName, subscriptionId	Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.
update	UPDATE	jobName, resourceGroupName, subscriptionId	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.

SELECT examples

Returns all active and completed jobs in a subscription.

vw_jobs

SELECT
id,
name,
backup_drive_manifest,
cancel_requested,
delivery_package,
diagnostics_path,
drive_list,
encryption_key,
export,
identity,
incomplete_blob_list_uri,
jobName,
job_type,
location,
log_level,
percent_complete,
provisioning_state,
resourceGroupName,
return_address,
return_package,
return_shipping,
shipping_information,
state,
storage_account_id,
subscriptionId,
system_data,
tags,
type
FROM azure.storage_import_export.vw_jobs
WHERE subscriptionId = '{{ subscriptionId }}';

jobs

SELECT
id,
name,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.storage_import_export.jobs
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new jobs resource.

All Properties

/*+ create */
INSERT INTO azure.storage_import_export.jobs (
jobName,
resourceGroupName,
subscriptionId,
location,
tags,
properties
)
SELECT 
'{{ jobName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: storageAccountId
          value: string
        - name: jobType
          value: string
        - name: returnAddress
          value:
            - name: recipientName
              value: string
            - name: streetAddress1
              value: string
            - name: streetAddress2
              value: string
            - name: city
              value: string
            - name: stateOrProvince
              value: string
            - name: postalCode
              value: string
            - name: countryOrRegion
              value: string
            - name: phone
              value: string
            - name: email
              value: string
        - name: returnShipping
          value:
            - name: carrierName
              value: string
            - name: carrierAccountNumber
              value: string
        - name: shippingInformation
          value:
            - name: recipientName
              value: string
            - name: streetAddress1
              value: string
            - name: streetAddress2
              value: string
            - name: city
              value: string
            - name: stateOrProvince
              value: string
            - name: postalCode
              value: string
            - name: countryOrRegion
              value: string
            - name: phone
              value: string
            - name: additionalInformation
              value: string
        - name: deliveryPackage
          value:
            - name: carrierName
              value: string
            - name: trackingNumber
              value: string
            - name: driveCount
              value: integer
            - name: shipDate
              value: string
        - name: returnPackage
          value:
            - name: carrierName
              value: string
            - name: trackingNumber
              value: string
            - name: driveCount
              value: integer
            - name: shipDate
              value: string
        - name: diagnosticsPath
          value: string
        - name: logLevel
          value: string
        - name: backupDriveManifest
          value: boolean
        - name: state
          value: string
        - name: cancelRequested
          value: boolean
        - name: percentComplete
          value: integer
        - name: incompleteBlobListUri
          value: string
        - name: driveList
          value:
            - - name: driveId
                value: string
              - name: bitLockerKey
                value: string
              - name: manifestFile
                value: string
              - name: manifestHash
                value: string
              - name: driveHeaderHash
                value: string
              - name: state
                value: string
              - name: copyStatus
                value: string
              - name: percentComplete
                value: integer
              - name: verboseLogUri
                value: string
              - name: errorLogUri
                value: string
              - name: manifestUri
                value: string
              - name: bytesSucceeded
                value: integer
        - name: export
          value:
            - name: blobList
              value: string
            - name: blobListBlobPath
              value: string
        - name: provisioningState
          value: string
        - name: encryptionKey
          value:
            - name: kekType
              value: string
            - name: kekUrl
              value: string
            - name: kekVaultResourceID
              value: string

UPDATE example

Updates a jobs resource.

/*+ update */
UPDATE azure.storage_import_export.jobs
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified jobs resource.

/*+ delete */
DELETE FROM azure.storage_import_export.jobs
WHERE jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';