auto_export_jobs

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

Overview

Name	auto_export_jobs
Type	Resource
Id	azure.storage_cache.auto_export_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 auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. Known values are: "Enable" and "Disable". (Enable, Disable)
autoExportPrefixes	array	An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1.
location	string	The geo-location where the resource lives. Required.
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 auto export.
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 auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. Known values are: "Enable" and "Disable". (Enable, Disable)
autoExportPrefixes	array	An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1.
location	string	The geo-location where the resource lives. Required.
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 auto export.
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, auto_export_job_name, subscription_id		Returns an auto export job.
list_by_aml_filesystem	select	resource_group_name, aml_filesystem_name, subscription_id		Returns all the auto export jobs the user has access to under an AML File System.
create_or_update	insert	resource_group_name, aml_filesystem_name, auto_export_job_name, subscription_id, location		Create or update an auto export job.
update	update	resource_group_name, aml_filesystem_name, auto_export_job_name, subscription_id		Update an auto export job instance.
create_or_update	replace	resource_group_name, aml_filesystem_name, auto_export_job_name, subscription_id, location		Create or update an auto export job.
delete	delete	resource_group_name, aml_filesystem_name, auto_export_job_name, subscription_id		Schedules an auto export 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.
auto_export_job_name	string	Name for the auto export 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 auto export job.

SELECT
id,
name,
adminStatus,
autoExportPrefixes,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.storage_cache.auto_export_jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' -- required
AND auto_export_job_name = '{{ auto_export_job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_aml_filesystem

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

SELECT
id,
name,
adminStatus,
autoExportPrefixes,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.storage_cache.auto_export_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 auto export job.

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

Manifest

# Description fields are for documentation purposes
- name: auto_export_jobs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the auto_export_jobs resource.
  - name: aml_filesystem_name
    value: "{{ aml_filesystem_name }}"
    description: Required parameter for the auto_export_jobs resource.
  - name: auto_export_job_name
    value: "{{ auto_export_job_name }}"
    description: Required parameter for the auto_export_jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the auto_export_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 auto export job.
    value:
      provisioningState: "{{ provisioningState }}"
      adminStatus: "{{ adminStatus }}"
      autoExportPrefixes:
        - "{{ autoExportPrefixes }}"
      status:
        state: "{{ state }}"
        statusCode: "{{ statusCode }}"
        statusMessage: "{{ statusMessage }}"
        totalFilesExported: {{ totalFilesExported }}
        totalMiBExported: {{ totalMiBExported }}
        totalFilesFailed: {{ totalFilesFailed }}
        exportIterationCount: {{ exportIterationCount }}
        lastSuccessfulIterationCompletionTimeUTC: "{{ lastSuccessfulIterationCompletionTimeUTC }}"
        currentIterationFilesDiscovered: {{ currentIterationFilesDiscovered }}
        currentIterationMiBDiscovered: {{ currentIterationMiBDiscovered }}
        currentIterationFilesExported: {{ currentIterationFilesExported }}
        currentIterationMiBExported: {{ currentIterationMiBExported }}
        currentIterationFilesFailed: {{ currentIterationFilesFailed }}
        lastStartedTimeUTC: "{{ lastStartedTimeUTC }}"
        lastCompletionTimeUTC: "{{ lastCompletionTimeUTC }}"

UPDATE examples

update

Update an auto export job instance.

UPDATE azure.storage_cache.auto_export_jobs
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' --required
AND auto_export_job_name = '{{ auto_export_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 auto export job.

REPLACE azure.storage_cache.auto_export_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 auto_export_job_name = '{{ auto_export_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 auto export job for deletion.

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