jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.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.
identity	object	Specifies the job identity details
location	string	Specifies the Azure location where the job is created.
properties	object	Specifies the job properties
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.
identity	object	Specifies the job identity details
location	string	Specifies the Azure location where the job is created.
properties	object	Specifies the job properties
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.
identity	object	Specifies the job identity details
location	string	Specifies the Azure location where the job is created.
properties	object	Specifies the job properties
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	jobName, subscriptionId, resourceGroupName	api-version, Accept-Language	Gets information about an existing job.
list_by_resource_group	select	subscriptionId, resourceGroupName	$top, $filter, api-version, Accept-Language	Returns all active and completed jobs in a resource group.
list_by_subscription	select	subscriptionId	$top, $filter, api-version, Accept-Language	Returns all active and completed jobs in a subscription.
create	insert	jobName, subscriptionId, resourceGroupName	api-version, Accept-Language, x-ms-client-tenant-id	Creates a new job or updates an existing job in the specified subscription.
update	update	jobName, subscriptionId, resourceGroupName	api-version, 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	jobName, subscriptionId, resourceGroupName	api-version, 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
jobName	string	The name of the import/export job.
resourceGroupName	string	The resource group name uniquely identifies the resource group within the user subscription.
subscriptionId	string	The subscription ID for the Azure user.
$filter	string	Can be used to restrict the results to certain conditions.
$top	integer (int64)	An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.
Accept-Language	string	Specifies the preferred language for the response.
api-version	string	Specifies the API version to use for this request.
x-ms-client-tenant-id	string	The tenant ID of the client making the request.

SELECT examples

get

Gets information about an existing job.

SELECT
id,
name,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.storage_import_export.jobs
WHERE jobName = '{{ jobName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND Accept-Language = '{{ Accept-Language }}'
;

list_by_resource_group

Returns all active and completed jobs in a resource group.

SELECT
id,
name,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.storage_import_export.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
AND api-version = '{{ api-version }}'
AND Accept-Language = '{{ Accept-Language }}'
;

list_by_subscription

Returns all active and completed jobs in a subscription.

SELECT
id,
name,
identity,
location,
properties,
systemData,
tags,
type
FROM azure.storage_import_export.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
AND api-version = '{{ api-version }}'
AND Accept-Language = '{{ Accept-Language }}'
;

INSERT examples

create

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

INSERT INTO azure.storage_import_export.jobs (
data__location,
data__tags,
data__properties,
jobName,
subscriptionId,
resourceGroupName,
api-version,
Accept-Language,
x-ms-client-tenant-id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ jobName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ api-version }}',
'{{ Accept-Language }}',
'{{ x-ms-client-tenant-id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: jobName
      value: string
      description: Required parameter for the jobs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the jobs resource.
    - name: location
      value: string
      description: |
        Specifies the supported Azure location where the job should be created
    - name: tags
      value: object
      description: |
        Specifies the tags that will be assigned to the job.
    - name: properties
      value: object
      description: |
        Specifies the job properties
    - name: api-version
      value: string
      description: Specifies the API version to use for this request.
    - name: Accept-Language
      value: string
      description: Specifies the preferred language for the response.
    - name: x-ms-client-tenant-id
      value: string
      description: The tenant ID of the client making the request.

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.storage_import_export.jobs
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
jobName = '{{ jobName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND api-version = '{{ api-version}}'
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.storage_import_export.jobs
WHERE jobName = '{{ jobName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND api-version = '{{ api-version }}'
AND Accept-Language = '{{ Accept-Language }}'
;