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 rgOptional Parameters
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 rgOptional Parameters
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 16Optional Parameters
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.
Region that the AML file system will be created in.
SKU name for this resource.
The size of the AML file system, in TiB.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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_idRequired Parameters
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Specifies the location of the encryption key in Key Vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Specifies HSM settings of the AML file system. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Start time of a 30-minute weekly maintenance window. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
SKU name for this resource.
The size of the AML file system, in TiB. This might be rounded up.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 rgOptional Parameters
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 16Optional Parameters
SKU name for this resource.
The size of the AML file system, in TiB.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 rgOptional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 rgOptional Parameters
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 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>.
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
Specifies the location of the encryption key in Key Vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Start time of a 30-minute weekly maintenance window. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for