az amlfs expansion

Note

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

Manage Expansion.

Commands

Name	Description	Type	Status
az amlfs expansion create	Increase filesystem storage capacity.	Extension	GA
az amlfs expansion delete	Delete an expansion job.	Extension	GA
az amlfs expansion list	List all the expansion jobs the user has access to under an AML File System.	Extension	GA
az amlfs expansion show	Get an expansion job.	Extension	GA
az amlfs expansion update	Update an expansion job instance.	Extension	GA
az amlfs expansion wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az amlfs expansion create

Increase filesystem storage capacity.

az amlfs expansion create --aml-filesystem-name
                          --expansion-job-name --name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]
                          [--location]
                          [--new-storage-capacity --size]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--tags]

Examples

expansionJobs_CreateOrUpdate

az amlfs expansion create --resource-group scgroup --aml-filesystem-name fs1 --expansion-job-name expansionjob1 --tags "{Dept:ContosoAds}" --location eastus --new-storage-capacity 16.0

Required Parameters

--aml-filesystem-name

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

--expansion-job-name --name -n

Name for the expansion job. 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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:	ExpansionJob Arguments

--new-storage-capacity --size

The new storage capacity in TiB for the AML file system after expansion. This must be a multiple of the Sku step size, and greater than the current storage capacity of the AML file system.

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

--tags

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

Property	Value
Parameter group:	ExpansionJob 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 expansion delete

Delete an expansion job.

az amlfs expansion delete [--acquire-policy-token]
                          [--aml-filesystem-name]
                          [--change-reference]
                          [--expansion-job-name --name]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

expansionJobs_Delete

az amlfs expansion delete --resource-group scgroup --aml-filesystem-name fs1 --expansion-job-name expansionjob1

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--aml-filesystem-name

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

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--expansion-job-name --name -n

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

Property	Value
Parameter group:	Resource Id Arguments

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

--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 expansion list

List all the expansion jobs the user has access to under an AML File System.

az amlfs expansion list --aml-filesystem-name
                        --resource-group
                        [--max-items]
                        [--next-token]

Examples

expansionJobs_ListByAmlFilesystem

az amlfs expansion list --resource-group scgroup --aml-filesystem-name fs1

Required Parameters

--aml-filesystem-name

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.

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

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 expansion show

Get an expansion job.

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

Examples

expansionJobs_Get

az amlfs expansion show --resource-group scgroup --aml-filesystem-name fs1 --expansion-job-name expansionjob1

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 for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

Property	Value
Parameter group:	Resource Id Arguments

--expansion-job-name --name -n

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

Property	Value
Parameter group:	Resource Id Arguments

--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 expansion update

Update an expansion job instance.

Use this command to update tags on an expansion job instance. No other property can be modified.

az amlfs expansion update [--acquire-policy-token]
                          [--aml-filesystem-name]
                          [--change-reference]
                          [--expansion-job-name --name]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--tags]

Examples

expansionJobs_Update

az amlfs expansion update --resource-group scgroup --aml-filesystem-name fs1 --expansion-job-name expansionjob1 --tags "{Dept:ContosoFinance}"

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--aml-filesystem-name

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

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--expansion-job-name --name -n

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

Property	Value
Parameter group:	Resource Id Arguments

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

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

--tags

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

Property	Value
Parameter group:	ExpansionJob 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 expansion wait

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

az amlfs expansion wait [--acquire-policy-token]
                        [--aml-filesystem-name]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--expansion-job-name --name]
                        [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--aml-filesystem-name

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

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

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

--expansion-job-name --name -n

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

Property	Value
Parameter group:	Resource Id Arguments

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

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