Share via

az amlfs auto-export

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 auto-export command. Learn more about extensions.

Manage Auto Export Job.

Commands

Name Description Type Status
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 auto-export create

Create an auto export job.

az amlfs auto-export create --aml-filesystem-name
                            --auto-export-job-name --name
                            --resource-group
                            [--admin-status {Disable, Enable}]
                            [--auto-export-prefixes]
                            [--location]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--tags]

Examples

autoExportJobs_CreateOrUpdate

az amlfs auto-export create --resource-group scgroup --aml-filesystem-name fs1 --auto-export-job-name job1 --tags "{Dept:ContosoAds}" --location eastus --auto-export-prefixes "[/]"

Required Parameters

--aml-filesystem-name

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

--auto-export-job-name --name -n

Name for the auto export 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

--admin-status

The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'.

Accepted values: Disable, Enable
Default value: Enable
--auto-export-prefixes

An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. 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.

--no-wait

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

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.

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 auto-export delete

Delete an auto export job for deletion.

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

Examples

autoExportJobs_Delete

az amlfs auto-export delete --resource-group scgroup --aml-filesystem-name fs1 --auto-export-job-name job1

Optional Parameters

--aml-filesystem-name

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

--auto-export-job-name --name -n

Name for the auto export job. 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 auto-export list

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

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

Examples

autoExportJobs_ListByAmlFilesystem

az amlfs auto-export 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

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

--next-token

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

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 auto-export show

Get an auto export job.

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

Examples

autoExportJobs_Get

az amlfs auto-export show --resource-group scgroup --aml-filesystem-name fs1 --auto-export-job-name job1

Optional Parameters

--aml-filesystem-name

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

--auto-export-job-name --name -n

Name for the auto export job. 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 auto-export update

Update an auto export job instance.

az amlfs auto-export update [--admin-status {Disable, Enable}]
                            [--aml-filesystem-name]
                            [--auto-export-job-name --name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--tags]

Examples

autoExportJobs_CreateOrUpdate

az amlfs auto-export-job update --resource-group scgroup --aml-filesystem-name fs1 --auto-export-job-name job1 --admin-status Disable

Optional Parameters

--admin-status

The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'.

Accepted values: Disable, Enable
--aml-filesystem-name

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

--auto-export-job-name --name -n

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

--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 auto-export wait

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

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

Optional Parameters

--aml-filesystem-name

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

--auto-export-job-name --name -n

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