import_jobs

Creates, updates, deletes, gets or lists an import_jobs resource.

Overview

Name	import_jobs
Type	Resource
Id	azure.storage_cache.import_jobs

Fields

The following fields are returned by SELECT queries:

get

Returns the import job object corresponding to amlFilesystemName.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the import job.
tags	object	Resource tags.

list_by_aml_filesystem

A list of import jobs. Note that entity references might replace complete AmlFilesystem objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the import job.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, amlFilesystemName, subscriptionId, importJobName		Returns an import job.
list_by_aml_filesystem	select	resourceGroupName, subscriptionId, amlFilesystemName		Returns all import jobs the user has access to under an AML File System.
create_or_update	insert	resourceGroupName, subscriptionId, amlFilesystemName, importJobName		Create or update an import job. Import jobs are automatically deleted 72 hours after completion.
update	update	resourceGroupName, subscriptionId, amlFilesystemName, importJobName		Update an import job instance.
delete	delete	resourceGroupName, amlFilesystemName, subscriptionId, importJobName		Schedules an import job for deletion.

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
amlFilesystemName	string	Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
importJobName	string	Name for the import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Returns an import job.

SELECT
location,
properties,
tags
FROM azure.storage_cache.import_jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND amlFilesystemName = '{{ amlFilesystemName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND importJobName = '{{ importJobName }}' -- required
;

list_by_aml_filesystem

Returns all import jobs the user has access to under an AML File System.

SELECT
location,
properties,
tags
FROM azure.storage_cache.import_jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND amlFilesystemName = '{{ amlFilesystemName }}' -- required
;

INSERT examples

create_or_update

Create or update an import job. Import jobs are automatically deleted 72 hours after completion.

INSERT INTO azure.storage_cache.import_jobs (
data__tags,
data__location,
data__properties,
resourceGroupName,
subscriptionId,
amlFilesystemName,
importJobName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ amlFilesystemName }}',
'{{ importJobName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: import_jobs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the import_jobs resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the import_jobs resource.
    - name: amlFilesystemName
      value: string
      description: Required parameter for the import_jobs resource.
    - name: importJobName
      value: string
      description: Required parameter for the import_jobs resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of the import job.

UPDATE examples

update

Update an import job instance.

UPDATE azure.storage_cache.import_jobs
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND amlFilesystemName = '{{ amlFilesystemName }}' --required
AND importJobName = '{{ importJobName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Schedules an import job for deletion.

DELETE FROM azure.storage_cache.import_jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND amlFilesystemName = '{{ amlFilesystemName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND importJobName = '{{ importJobName }}' --required
;