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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
adminStatus	string	The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. Known values are: "Active" and "Cancel". (Active, Cancel)
conflictResolutionMode	string	How the import job will handle conflicts. For example, if the import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or was not previously imported. OverwriteAlways extends OverwriteIfDirty to include releasing files that had been restored but were not dirty. Please reference https://learn.microsoft.com/en-us/azure/azure-managed-lustre/ _ for a thorough explanation of these resolution modes. Known values are: "Fail", "Skip", "OverwriteIfDirty", and "OverwriteAlways". (Fail, Skip, OverwriteIfDirty, OverwriteAlways)
importPrefixes	array	An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value.
location	string	The geo-location where the resource lives. Required.
maximumErrors	integer	Total non-conflict oriented errors the import job will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately and is the default.
provisioningState	string	ARM provisioning state. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
status	object	The status of the import.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_aml_filesystem

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
adminStatus	string	The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. Known values are: "Active" and "Cancel". (Active, Cancel)
conflictResolutionMode	string	How the import job will handle conflicts. For example, if the import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or was not previously imported. OverwriteAlways extends OverwriteIfDirty to include releasing files that had been restored but were not dirty. Please reference https://learn.microsoft.com/en-us/azure/azure-managed-lustre/ _ for a thorough explanation of these resolution modes. Known values are: "Fail", "Skip", "OverwriteIfDirty", and "OverwriteAlways". (Fail, Skip, OverwriteIfDirty, OverwriteAlways)
importPrefixes	array	An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value.
location	string	The geo-location where the resource lives. Required.
maximumErrors	integer	Total non-conflict oriented errors the import job will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately and is the default.
provisioningState	string	ARM provisioning state. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
status	object	The status of the import.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, aml_filesystem_name, import_job_name, subscription_id		Returns an import job.
list_by_aml_filesystem	select	resource_group_name, aml_filesystem_name, subscription_id		Returns all import jobs the user has access to under an AML File System.
create_or_update	insert	resource_group_name, aml_filesystem_name, import_job_name, subscription_id, location		Create or update an import job.
update	update	resource_group_name, aml_filesystem_name, import_job_name, subscription_id		Update an import job instance.
create_or_update	replace	resource_group_name, aml_filesystem_name, import_job_name, subscription_id, location		Create or update an import job.
delete	delete	resource_group_name, aml_filesystem_name, import_job_name, subscription_id		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
aml_filesystem_name	string	Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. Required.
import_job_name	string	Name for the import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Returns an import job.

SELECT
id,
name,
adminStatus,
conflictResolutionMode,
importPrefixes,
location,
maximumErrors,
provisioningState,
status,
systemData,
tags,
type
FROM azure.storage_cache.import_jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' -- required
AND import_job_name = '{{ import_job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_aml_filesystem

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

SELECT
id,
name,
adminStatus,
conflictResolutionMode,
importPrefixes,
location,
maximumErrors,
provisioningState,
status,
systemData,
tags,
type
FROM azure.storage_cache.import_jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an import job.

INSERT INTO azure.storage_cache.import_jobs (
tags,
location,
properties,
resource_group_name,
aml_filesystem_name,
import_job_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ aml_filesystem_name }}',
'{{ import_job_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: import_jobs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the import_jobs resource.
  - name: aml_filesystem_name
    value: "{{ aml_filesystem_name }}"
    description: Required parameter for the import_jobs resource.
  - name: import_job_name
    value: "{{ import_job_name }}"
    description: Required parameter for the import_jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the import_jobs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the import job.
    value:
      provisioningState: "{{ provisioningState }}"
      adminStatus: "{{ adminStatus }}"
      importPrefixes:
        - "{{ importPrefixes }}"
      conflictResolutionMode: "{{ conflictResolutionMode }}"
      maximumErrors: {{ maximumErrors }}
      status:
        state: "{{ state }}"
        statusMessage: "{{ statusMessage }}"
        totalBlobsWalked: {{ totalBlobsWalked }}
        blobsWalkedPerSecond: {{ blobsWalkedPerSecond }}
        totalBlobsImported: {{ totalBlobsImported }}
        importedFiles: {{ importedFiles }}
        importedDirectories: {{ importedDirectories }}
        importedSymlinks: {{ importedSymlinks }}
        preexistingFiles: {{ preexistingFiles }}
        preexistingDirectories: {{ preexistingDirectories }}
        preexistingSymlinks: {{ preexistingSymlinks }}
        blobsImportedPerSecond: {{ blobsImportedPerSecond }}
        lastCompletionTime: "{{ lastCompletionTime }}"
        lastStartedTime: "{{ lastStartedTime }}"
        totalErrors: {{ totalErrors }}
        totalConflicts: {{ totalConflicts }}

UPDATE examples

update

Update an import job instance.

UPDATE azure.storage_cache.import_jobs
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' --required
AND import_job_name = '{{ import_job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update an import job.

REPLACE azure.storage_cache.import_jobs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' --required
AND import_job_name = '{{ import_job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Schedules an import job for deletion.

DELETE FROM azure.storage_cache.import_jobs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' --required
AND import_job_name = '{{ import_job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;