az amlfs

Note

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

This is an extension to Azure CLI to manage Amlfs resources.

Commands

Name	Description	Type	Status
az amlfs archive	Archive data from the AML file system.	Extension	GA
az amlfs auto-export	Manage Auto Export Job.	Extension	GA
az amlfs auto-export create	Create an auto export job.	Extension	GA
az amlfs auto-export delete	Delete an auto export job for deletion.	Extension	GA
az amlfs auto-export list	List all the auto export jobs the user has access to under an AML File System.	Extension	GA
az amlfs auto-export show	Get an auto export job.	Extension	GA
az amlfs auto-export update	Update an auto export job instance.	Extension	GA
az amlfs auto-export wait	Place the CLI in a waiting state until a condition is met.	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 import	Manage Import Job.	Extension	GA
az amlfs import create	Create an import job.	Extension	GA
az amlfs import delete	Delete an import job for deletion.	Extension	GA
az amlfs import list	List all import jobs the user has access to under an AML File System.	Extension	GA
az amlfs import show	Get an import job.	Extension	GA
az amlfs import update	Update an import job instance.	Extension	GA
az amlfs import wait	Place the CLI in a waiting state until a condition is met.	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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--amlfs-name

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

Property	Value
Parameter group:	Resource Id Arguments

--filesystem-path

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

Property	Value
Parameter group:	ArchiveInfo Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--amlfs-name

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

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property	Value
Parameter group:	AmlFilesystemSubnetInfo Arguments

--location

Region that the AML file system will be created in.

Property	Value
Parameter group:	AmlFilesystemSubnetInfo Arguments

--sku

SKU name for this resource.

Property	Value
Parameter group:	Sku Arguments

--storage-capacity

The size of the AML file system, in TiB.

Property	Value
Parameter group:	AmlFilesystemSubnetInfo Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az amlfs create

Create an AML file system.

az amlfs create --aml-filesystem-name --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--encryption-setting

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

Property	Value
Parameter group:	EncryptionSettings Arguments

--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.

Property	Value
Parameter group:	Properties Arguments

--hsm-settings

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

Property	Value
Parameter group:	Hsm Arguments

--location -l

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

Property	Value
Parameter group:	AmlFilesystem Arguments

--maintenance-window

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

Property	Value
Parameter group:	Properties Arguments

--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.

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

--sku

SKU name for this resource.

Property	Value
Parameter group:	Sku Arguments

--storage-capacity

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

Property	Value
Parameter group:	Properties Arguments

--tags

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

Property	Value
Parameter group:	AmlFilesystem Arguments

--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.

Property	Value
Parameter group:	AmlFilesystem Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az amlfs delete

Delete an AML file system for deletion.

az amlfs delete [--aml-filesystem-name --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
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>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--sku

SKU name for this resource.

Property	Value
Parameter group:	Sku Arguments

--storage-capacity

The size of the AML file system, in TiB.

Property	Value
Parameter group:	RequiredAMLFilesystemSubnetsSizeInfo Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az amlfs list

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

az amlfs list [--max-items]
              [--next-token]
              [--resource-group]

Examples

List amlfs

az amlfs list -g rg

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az amlfs show

Get an AML file system.

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

Examples

Show amlfs

az amlfs show -n name -g rg

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az amlfs update

Update an AML file system.

az amlfs update [--add]
                [--aml-filesystem-name --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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>.

Property	Value
Parameter group:	Generic Update Arguments

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

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

Property	Value
Parameter group:	Resource Id Arguments

--encryption-setting

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

Property	Value
Parameter group:	EncryptionSettings Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

Property	Value
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.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

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

Property	Value
Parameter group:	AmlFilesystem Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az amlfs wait

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

Share via

az amlfs

Commands

az amlfs archive

Examples

Optional Parameters

az amlfs cancel-archive

Examples

Optional Parameters

az amlfs check-amlfs-subnet

Examples

Optional Parameters

az amlfs create

Examples

Required Parameters

Optional Parameters

az amlfs delete

Examples

Optional Parameters

az amlfs get-subnets-size

Examples

Optional Parameters

az amlfs list

Examples

Optional Parameters

az amlfs show

Examples

Optional Parameters

az amlfs update

Examples

Optional Parameters

az amlfs wait

Optional Parameters

Feedback