az amlfs

Note

This reference is part of the amlfs extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an az amlfs command. Learn more about extensions.

Manage lustre file system.

Commands

Name	Description	Type	Status
az amlfs archive	Archive data from the AML file system.	Extension	GA
az amlfs cancel-archive	Cancel archiving data from the AML file system.	Extension	GA
az amlfs check-amlfs-subnet	Check that subnets will be valid for AML file system create calls.	Extension	GA
az amlfs create	Create an AML file system.	Extension	GA
az amlfs delete	Delete an AML file system for deletion.	Extension	GA
az amlfs get-subnets-size	Get the number of available IP addresses needed for the AML file system information provided.	Extension	GA
az amlfs list	List all AML file systems the user has access to under a resource group.	Extension	GA
az amlfs show	Get an AML file system.	Extension	GA
az amlfs update	Update an AML file system.	Extension	GA
az amlfs wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az amlfs archive

Archive data from the AML file system.

az amlfs archive [--amlfs-name]
                 [--filesystem-path]
                 [--ids]
                 [--resource-group]
                 [--subscription]

Examples

Amlfs archive

az amlfs archive --amlfs-name name -g rg

Optional Parameters

--amlfs-name

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--filesystem-path

Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data.

Default value: /

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs cancel-archive

Cancel archiving data from the AML file system.

az amlfs cancel-archive [--amlfs-name]
                        [--ids]
                        [--resource-group]
                        [--subscription]

Examples

Amlfs cancel-archive

az amlfs cancel-archive --amlfs-name name -g rg

Optional Parameters

--amlfs-name

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs check-amlfs-subnet

Check that subnets will be valid for AML file system create calls.

az amlfs check-amlfs-subnet [--filesystem-subnet]
                            [--location]
                            [--sku]
                            [--storage-capacity]

Examples

Amlfs check subnet

az amlfs check-amlfs-subnet --filesystem-subnet subnet_id --sku AMLFS-Durable-Premium-250 --location eastus --storage-capacity-tb 16

Optional Parameters

--filesystem-subnet

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.

--location

Region that the AML file system will be created in.

--sku

SKU name for this resource.

--storage-capacity

The size of the AML file system, in TiB.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs create

Create an AML file system.

az amlfs create --aml-filesystem-name
                --resource-group
                [--encryption-setting]
                [--filesystem-subnet]
                [--hsm-settings]
                [--location]
                [--maintenance-window]
                [--mi-user-assigned]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--sku]
                [--storage-capacity]
                [--tags]
                [--zones]

Examples

Create amlfs

az amlfs create -n amlfs_name -g rg --sku AMLFS-Durable-Premium-250 --storage-capacity 16 --zones [1] --maintenance-window "{dayOfWeek:friday,timeOfDayUtc:'22:00'}" --filesystem-subnet subnet_id

Required Parameters

--aml-filesystem-name --name -n

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--encryption-setting

Specifies the location of the encryption key in Key Vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--filesystem-subnet

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.

--hsm-settings

Specifies HSM settings of the AML file system. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--maintenance-window

Start time of a 30-minute weekly maintenance window. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--mi-user-assigned

Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--sku

SKU name for this resource.

--storage-capacity

The size of the AML file system, in TiB. This might be rounded up.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--zones

Availability zones for resources. This field should only contain a single element in the array. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs delete

Delete an AML file system for deletion.

az amlfs delete [--aml-filesystem-name]
                [--ids]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--resource-group]
                [--subscription]
                [--yes]

Examples

Delete amlfs

az amlfs delete -n amlfs_name -g rg

Optional Parameters

--aml-filesystem-name --name -n

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs get-subnets-size

Get the number of available IP addresses needed for the AML file system information provided.

az amlfs get-subnets-size [--sku]
                          [--storage-capacity]

Examples

Amlfs get subnet-size

az amlfs get-subnets-size --sku AMLFS-Durable-Premium-250 --storage-capacity-tb 16

Optional Parameters

--sku

SKU name for this resource.

--storage-capacity

The size of the AML file system, in TiB.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs list

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

az amlfs list [--resource-group]

Examples

List amlfs

az amlfs list -g rg

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs show

Get an AML file system.

az amlfs show [--aml-filesystem-name]
              [--ids]
              [--resource-group]
              [--subscription]

Examples

Show amlfs

az amlfs show -n name -g rg

Optional Parameters

--aml-filesystem-name --name -n

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs update

Update an AML file system.

az amlfs update [--add]
                [--aml-filesystem-name]
                [--encryption-setting]
                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                [--ids]
                [--maintenance-window]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--remove]
                [--resource-group]
                [--set]
                [--subscription]
                [--tags]

Examples

Update amlfs

az amlfs update -n name -g rg --tags "{tag:test}"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--aml-filesystem-name --name -n

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--encryption-setting

Specifies the location of the encryption key in Key Vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--maintenance-window

Start time of a 30-minute weekly maintenance window. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az amlfs wait

Place the CLI in a waiting state until a condition is met.

az amlfs wait [--aml-filesystem-name]
              [--created]
              [--custom]
              [--deleted]
              [--exists]
              [--ids]
              [--interval]
              [--resource-group]
              [--subscription]
              [--timeout]
              [--updated]

Optional Parameters

--aml-filesystem-name --name -n

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.