aml_filesystems

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

Overview

Name	aml_filesystems
Type	Resource
Id	azure.storage_cache.aml_filesystems

Fields

The following fields are returned by SELECT queries:

get

Returns the AML file system object corresponding to amlFilesystemName.

Name	Datatype	Description
identity	object	The managed identity used by the AML file system, if configured.
location	string	The geo-location where the resource lives
properties	object	Properties of the AML file system.
sku	object	SKU for the resource.
tags	object	Resource tags.
zones	array	Availability zones for resources. This field should only contain a single element in the array.

list_by_resource_group

A list of AmlFilesystem objects. 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
identity	object	The managed identity used by the AML file system, if configured.
location	string	The geo-location where the resource lives
properties	object	Properties of the AML file system.
sku	object	SKU for the resource.
tags	object	Resource tags.
zones	array	Availability zones for resources. This field should only contain a single element in the array.

list

A list of AML file systems. Note that entity references might replace complete file system 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
identity	object	The managed identity used by the AML file system, if configured.
location	string	The geo-location where the resource lives
properties	object	Properties of the AML file system.
sku	object	SKU for the resource.
tags	object	Resource tags.
zones	array	Availability zones for resources. This field should only contain a single element in the array.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, amlFilesystemName, subscriptionId		Returns an AML file system.
list_by_resource_group	select	resourceGroupName, subscriptionId		Returns all AML file systems the user has access to under a resource group.
list	select	subscriptionId		Returns all AML file systems the user has access to under a subscription.
create_or_update	insert	resourceGroupName, subscriptionId, amlFilesystemName		Create or update an AML file system.
update	update	resourceGroupName, subscriptionId, amlFilesystemName		Update an AML file system instance.
delete	delete	resourceGroupName, amlFilesystemName, subscriptionId		Schedules an AML file system for deletion.
archive	exec	resourceGroupName, subscriptionId, amlFilesystemName		Archive data from the AML file system.
cancel_archive	exec	resourceGroupName, subscriptionId, amlFilesystemName		Cancel archiving data from the AML file system.

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.
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 AML file system.

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

list_by_resource_group

Returns all AML file systems the user has access to under a resource group.

SELECT
identity,
location,
properties,
sku,
tags,
zones
FROM azure.storage_cache.aml_filesystems
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Returns all AML file systems the user has access to under a subscription.

SELECT
identity,
location,
properties,
sku,
tags,
zones
FROM azure.storage_cache.aml_filesystems
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update an AML file system.

INSERT INTO azure.storage_cache.aml_filesystems (
data__tags,
data__location,
data__identity,
data__sku,
data__zones,
data__properties,
resourceGroupName,
subscriptionId,
amlFilesystemName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ sku }}',
'{{ zones }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ amlFilesystemName }}'
RETURNING
identity,
location,
properties,
sku,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: aml_filesystems
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the aml_filesystems resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the aml_filesystems resource.
    - name: amlFilesystemName
      value: string
      description: Required parameter for the aml_filesystems resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        The managed identity used by the AML file system, if configured.
    - name: sku
      value: object
      description: |
        SKU for the resource.
    - name: zones
      value: array
      description: |
        Availability zones for resources. This field should only contain a single element in the array.
    - name: properties
      value: object
      description: |
        Properties of the AML file system.

UPDATE examples

update

Update an AML file system instance.

UPDATE azure.storage_cache.aml_filesystems
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND amlFilesystemName = '{{ amlFilesystemName }}' --required
RETURNING
identity,
location,
properties,
sku,
tags,
zones;

DELETE examples

delete

Schedules an AML file system for deletion.

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

Lifecycle Methods

archive

Archive data from the AML file system.

EXEC azure.storage_cache.aml_filesystems.archive 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@amlFilesystemName='{{ amlFilesystemName }}' --required 
@@json=
'{
"filesystemPath": "{{ filesystemPath }}"
}'
;

cancel_archive

Cancel archiving data from the AML file system.

EXEC azure.storage_cache.aml_filesystems.cancel_archive 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@amlFilesystemName='{{ amlFilesystemName }}' --required
;