expansion_jobs

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

Overview

Name	expansion_jobs
Type	Resource
Id	azure.storage_cache.expansion_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.
location	string	The geo-location where the resource lives. Required.
newStorageCapacityTiB	number	The new storage capacity in TiB for the AML file system after expansion. This must be a multiple of the Sku step size, and greater than the current storage capacity of the AML file system.
provisioningState	string	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property _. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
status	object	The status of the expansion job.
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.
location	string	The geo-location where the resource lives. Required.
newStorageCapacityTiB	number	The new storage capacity in TiB for the AML file system after expansion. This must be a multiple of the Sku step size, and greater than the current storage capacity of the AML file system.
provisioningState	string	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property _. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
status	object	The status of the expansion job.
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, expansion_job_name, subscription_id		Returns an expansion job.
list_by_aml_filesystem	select	resource_group_name, aml_filesystem_name, subscription_id		Returns all the expansion jobs the user has access to under an AML File System.
create_or_update	insert	resource_group_name, aml_filesystem_name, expansion_job_name, subscription_id, location		Create or update an expansion job.
update	update	resource_group_name, aml_filesystem_name, expansion_job_name, subscription_id		Update an expansion job instance.
create_or_update	replace	resource_group_name, aml_filesystem_name, expansion_job_name, subscription_id, location		Create or update an expansion job.
delete	delete	resource_group_name, aml_filesystem_name, expansion_job_name, subscription_id		Schedules an expansion 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.
expansion_job_name	string	Name for the expansion 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 expansion job.

SELECT
id,
name,
location,
newStorageCapacityTiB,
provisioningState,
status,
systemData,
tags,
type
FROM azure.storage_cache.expansion_jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' -- required
AND expansion_job_name = '{{ expansion_job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_aml_filesystem

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

SELECT
id,
name,
location,
newStorageCapacityTiB,
provisioningState,
status,
systemData,
tags,
type
FROM azure.storage_cache.expansion_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 expansion job.

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

Manifest

# Description fields are for documentation purposes
- name: expansion_jobs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the expansion_jobs resource.
  - name: aml_filesystem_name
    value: "{{ aml_filesystem_name }}"
    description: Required parameter for the expansion_jobs resource.
  - name: expansion_job_name
    value: "{{ expansion_job_name }}"
    description: Required parameter for the expansion_jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the expansion_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 expansion job.
    value:
      provisioningState: "{{ provisioningState }}"
      newStorageCapacityTiB: {{ newStorageCapacityTiB }}
      status:
        state: "{{ state }}"
        statusCode: "{{ statusCode }}"
        statusMessage: "{{ statusMessage }}"
        percentComplete: {{ percentComplete }}
        startTimeUTC: "{{ startTimeUTC }}"
        completionTimeUTC: "{{ completionTimeUTC }}"

UPDATE examples

update

Update an expansion job instance.

UPDATE azure.storage_cache.expansion_jobs
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' --required
AND expansion_job_name = '{{ expansion_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 expansion job.

REPLACE azure.storage_cache.expansion_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 expansion_job_name = '{{ expansion_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 expansion job for deletion.

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