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

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.
clientInfo	object	Client information for the AML file system.
clusterUuid	string	The unique identifier of the AML file system cluster.
currentStorageCapacityTiB	number	The current storage capacity of the AML file system, in TiB. This reflects the actual capacity including any expansions.
encryptionSettings	object	Specifies encryption settings of the AML file system.
filesystemSubnet	string	Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space. Required.
health	object	Health of the AML file system.
hsm	object	Hydration and archive settings and status.
identity	object	The managed identity used by the AML file system, if configured.
location	string	The geo-location where the resource lives. Required.
maintenanceWindow	object	Start time of a 30-minute weekly maintenance window. Required.
provisioningState	string	ARM provisioning state. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
rootSquashSettings	object	Specifies root squash settings of the AML file system.
sku	object	SKU for the resource.
storageCapacityTiB	number	The size of the AML file system, in TiB. This might be rounded up. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
throughputProvisionedMBps	integer	Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list_by_resource_group

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.
clientInfo	object	Client information for the AML file system.
clusterUuid	string	The unique identifier of the AML file system cluster.
currentStorageCapacityTiB	number	The current storage capacity of the AML file system, in TiB. This reflects the actual capacity including any expansions.
encryptionSettings	object	Specifies encryption settings of the AML file system.
filesystemSubnet	string	Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space. Required.
health	object	Health of the AML file system.
hsm	object	Hydration and archive settings and status.
identity	object	The managed identity used by the AML file system, if configured.
location	string	The geo-location where the resource lives. Required.
maintenanceWindow	object	Start time of a 30-minute weekly maintenance window. Required.
provisioningState	string	ARM provisioning state. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
rootSquashSettings	object	Specifies root squash settings of the AML file system.
sku	object	SKU for the resource.
storageCapacityTiB	number	The size of the AML file system, in TiB. This might be rounded up. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
throughputProvisionedMBps	integer	Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list

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.
clientInfo	object	Client information for the AML file system.
clusterUuid	string	The unique identifier of the AML file system cluster.
currentStorageCapacityTiB	number	The current storage capacity of the AML file system, in TiB. This reflects the actual capacity including any expansions.
encryptionSettings	object	Specifies encryption settings of the AML file system.
filesystemSubnet	string	Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space. Required.
health	object	Health of the AML file system.
hsm	object	Hydration and archive settings and status.
identity	object	The managed identity used by the AML file system, if configured.
location	string	The geo-location where the resource lives. Required.
maintenanceWindow	object	Start time of a 30-minute weekly maintenance window. Required.
provisioningState	string	ARM provisioning state. Known values are: "Succeeded", "Failed", "Creating", "Deleting", "Updating", and "Canceled". (Succeeded, Failed, Creating, Deleting, Updating, Canceled)
rootSquashSettings	object	Specifies root squash settings of the AML file system.
sku	object	SKU for the resource.
storageCapacityTiB	number	The size of the AML file system, in TiB. This might be rounded up. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
throughputProvisionedMBps	integer	Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

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, subscription_id		Returns an AML file system.
list_by_resource_group	select	resource_group_name, subscription_id		Returns all AML file systems the user has access to under a resource group.
list	select	subscription_id		Returns all AML file systems the user has access to under a subscription.
create_or_update	insert	resource_group_name, aml_filesystem_name, subscription_id, location		Create or update an AML file system.
update	update	resource_group_name, aml_filesystem_name, subscription_id		Update an AML file system instance.
create_or_update	replace	resource_group_name, aml_filesystem_name, subscription_id, location		Create or update an AML file system.
delete	delete	resource_group_name, aml_filesystem_name, subscription_id		Schedules an AML file system for deletion.
archive	exec	resource_group_name, aml_filesystem_name, subscription_id		Archive data from the AML file system.
cancel_archive	exec	resource_group_name, aml_filesystem_name, subscription_id		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
aml_filesystem_name	string	Name for the AML file system. 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 AML file system.

SELECT
id,
name,
clientInfo,
clusterUuid,
currentStorageCapacityTiB,
encryptionSettings,
filesystemSubnet,
health,
hsm,
identity,
location,
maintenanceWindow,
provisioningState,
rootSquashSettings,
sku,
storageCapacityTiB,
systemData,
tags,
throughputProvisionedMBps,
type,
zones
FROM azure.storage_cache.aml_filesystems
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND aml_filesystem_name = '{{ aml_filesystem_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
clientInfo,
clusterUuid,
currentStorageCapacityTiB,
encryptionSettings,
filesystemSubnet,
health,
hsm,
identity,
location,
maintenanceWindow,
provisioningState,
rootSquashSettings,
sku,
storageCapacityTiB,
systemData,
tags,
throughputProvisionedMBps,
type,
zones
FROM azure.storage_cache.aml_filesystems
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
clientInfo,
clusterUuid,
currentStorageCapacityTiB,
encryptionSettings,
filesystemSubnet,
health,
hsm,
identity,
location,
maintenanceWindow,
provisioningState,
rootSquashSettings,
sku,
storageCapacityTiB,
systemData,
tags,
throughputProvisionedMBps,
type,
zones
FROM azure.storage_cache.aml_filesystems
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an AML file system.

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

Manifest

# Description fields are for documentation purposes
- name: aml_filesystems
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the aml_filesystems resource.
  - name: aml_filesystem_name
    value: "{{ aml_filesystem_name }}"
    description: Required parameter for the aml_filesystems resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the aml_filesystems 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 AML file system.
    value:
      storageCapacityTiB: {{ storageCapacityTiB }}
      currentStorageCapacityTiB: {{ currentStorageCapacityTiB }}
      clusterUuid: "{{ clusterUuid }}"
      health:
        state: "{{ state }}"
        statusCode: "{{ statusCode }}"
        statusDescription: "{{ statusDescription }}"
      provisioningState: "{{ provisioningState }}"
      filesystemSubnet: "{{ filesystemSubnet }}"
      clientInfo:
        mgsAddress: "{{ mgsAddress }}"
        mountCommand: "{{ mountCommand }}"
        lustreVersion: "{{ lustreVersion }}"
        containerStorageInterface:
          persistentVolumeClaim: "{{ persistentVolumeClaim }}"
          persistentVolume: "{{ persistentVolume }}"
          storageClass: "{{ storageClass }}"
      throughputProvisionedMBps: {{ throughputProvisionedMBps }}
      encryptionSettings:
        keyEncryptionKey:
          keyUrl: "{{ keyUrl }}"
          sourceVault:
            id: "{{ id }}"
      maintenanceWindow:
        dayOfWeek: "{{ dayOfWeek }}"
        timeOfDayUTC: "{{ timeOfDayUTC }}"
      hsm:
        settings:
          container: "{{ container }}"
          loggingContainer: "{{ loggingContainer }}"
          importPrefix: "{{ importPrefix }}"
          importPrefixesInitial:
            - "{{ importPrefixesInitial }}"
        archiveStatus:
          - filesystemPath: "{{ filesystemPath }}"
            status:
              state: "{{ state }}"
              lastCompletionTime: "{{ lastCompletionTime }}"
              lastStartedTime: "{{ lastStartedTime }}"
              percentComplete: {{ percentComplete }}
              errorCode: "{{ errorCode }}"
              errorMessage: "{{ errorMessage }}"
      rootSquashSettings:
        mode: "{{ mode }}"
        noSquashNidLists: "{{ noSquashNidLists }}"
        squashUID: {{ squashUID }}
        squashGID: {{ squashGID }}
        status: "{{ status }}"
  - name: identity
    description: |
      The managed identity used by the AML file system, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      SKU for the resource.
    value:
      name: "{{ name }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Update an AML file system instance.

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

REPLACE examples

create_or_update

Create or update an AML file system.

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

DELETE examples

delete

Schedules an AML file system for deletion.

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

Lifecycle Methods

archive

Archive data from the AML file system.

EXEC azure.storage_cache.aml_filesystems.archive 
@resource_group_name='{{ resource_group_name }}' --required, 
@aml_filesystem_name='{{ aml_filesystem_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"filesystemPath": "{{ filesystemPath }}"
}'
;

cancel_archive

Cancel archiving data from the AML file system.

EXEC azure.storage_cache.aml_filesystems.cancel_archive 
@resource_group_name='{{ resource_group_name }}' --required, 
@aml_filesystem_name='{{ aml_filesystem_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;