az edge-action version

Note

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

Manage Version.

Commands

Name	Description	Type	Status
az edge-action version create	Create EdgeActionVersion version.	Extension	GA
az edge-action version delete	Delete EdgeActionVersion resource.	Extension	GA
az edge-action version deploy-from-file	Deploy edge action version code from a JavaScript or zip file.	Extension	GA
az edge-action version deploy-version-code	A long-running operation to deploy versioncode to EdgeActionVersion resource.	Extension	GA
az edge-action version get-version-code	A long-running operation to get versioncode deployed to EdgeActionVersion resource.	Extension	GA
az edge-action version list	List EdgeActionVersion resources by EdgeAction.	Extension	GA
az edge-action version show	Get EdgeActionVersion resource.	Extension	GA
az edge-action version swap-default	A long-running resource action.	Extension	GA
az edge-action version update	Update EdgeActionVersion version.	Extension	GA
az edge-action version wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az edge-action version create

Create EdgeActionVersion version.

az edge-action version create --edge-action-name
                              --name --version
                              --resource-group
                              [--deployment-type {file, others, zip}]
                              [--is-default-version {False, True}]
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--tags]

Examples

CreateEdgeActionVersion

az edge-action version create --resource-group testrg --edge-action-name edgeAction1 --version version2 --location global --deployment-type zip --is-default-version True

Required Parameters

--edge-action-name

The name of the Edge Action.

--name --version -n

The name of the Edge Action version.

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

--deployment-type

The deployment type.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	file, others, zip

--is-default-version

The active state.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	False, True

--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:	Resource 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:	Resource 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 edge-action version delete

Delete EdgeActionVersion resource.

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

Examples

DeleteEdgeActionVersion

az edge-action version delete --resource-group testrg --edge-action-name edgeAction1 --version version1

Optional Parameters

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

--edge-action-name

The name of the Edge Action.

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

--name --version -n

The name of the Edge Action version.

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 edge-action version deploy-from-file

Deploy edge action version code from a JavaScript or zip file.

This command provides file-based deployment for edge action versions. It automatically detects the deployment type based on the file extension (.js for JavaScript files, .zip for zip archives) unless explicitly specified.

az edge-action version deploy-from-file --edge-action-name
                                        --file-path
                                        --resource-group
                                        --version
                                        [--deployment-type]

Examples

Deploy a JavaScript file to an edge action version

az edge-action version deploy-from-file --resource-group myResourceGroup --edge-action-name myEdgeAction --version v1 --file-path ./mycode.js

Deploy a zip file to an edge action version

az edge-action version deploy-from-file --resource-group myResourceGroup --edge-action-name myEdgeAction --version v1 --file-path ./mycode.zip

Deploy a JavaScript file with explicit deployment type

az edge-action version deploy-from-file --resource-group myResourceGroup --edge-action-name myEdgeAction --version v1 --file-path ./mycode.js --deployment-type file

Required Parameters

--edge-action-name

Name of the edge action.

--file-path

Path to JavaScript (.js) or zip (.zip) file to deploy.

--resource-group -g

Name of resource group.

--version

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

--deployment-type

Deployment type: "file" for JavaScript files, "zip" for zip archives. Auto-detected if not specified.

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 edge-action version deploy-version-code

A long-running operation to deploy versioncode to EdgeActionVersion resource.

az edge-action version deploy-version-code --content
                                           --name
                                           [--edge-action-name]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--version]

Examples

DeployEdgeActionVersionCode

az edge-action version deploy-version-code --resource-group testrg --edge-action-name edgeAction1 --version version2 --name version2 --content UEsDBBQAAAAIAI1NzkQAAAAABQAAAA==

Required Parameters

--content

The version code deployment content.

Property	Value
Parameter group:	Body Arguments

--name

The version code name.

Property	Value
Parameter group:	Body Arguments

Optional Parameters

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

--edge-action-name

The name of the Edge Action.

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

--version

The name of the Edge Action version.

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 edge-action version get-version-code

A long-running operation to get versioncode deployed to EdgeActionVersion resource.

az edge-action version get-version-code [--edge-action-name]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--output-directory]
                                        [--resource-group]
                                        [--subscription]
                                        [--version]

Examples

GetEdgeActionVersionCode

az edge-action version get-version-code --resource-group testrg --edge-action-name edgeAction1 --version version1

Optional Parameters

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

--edge-action-name

The name of the Edge Action.

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

--output-directory -d

Output directory to save the decoded version code as a zip file. If not specified, returns the base64-encoded content.

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

--version

The name of the Edge Action version.

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 edge-action version list

List EdgeActionVersion resources by EdgeAction.

az edge-action version list --edge-action-name
                            --resource-group
                            [--max-items]
                            [--next-token]

Examples

GetEdgeActionVersionsByEdgeAction

az edge-action version list --resource-group testrg --edge-action-name edgeAction1

Required Parameters

--edge-action-name

The name of the Edge Action.

--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 edge-action version show

Get EdgeActionVersion resource.

az edge-action version show [--edge-action-name]
                            [--ids]
                            [--name --version]
                            [--resource-group]
                            [--subscription]

Examples

GetEdgeActionVersion

az edge-action version show --resource-group testrg --edge-action-name edgeAction1 --version version1

Optional Parameters

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

--edge-action-name

The name of the Edge Action.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --version -n

The name of the Edge Action version.

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 edge-action version swap-default

A long-running resource action.

az edge-action version swap-default [--edge-action-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--version]

Examples

SwapDefaultEdgeActionVersion

az edge-action version swap-default --resource-group myResourceGroup --edge-action-name myEdgeAction --version v2

Optional Parameters

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

--edge-action-name

The name of the Edge Action.

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

--version

The name of the Edge Action version.

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 edge-action version update

Update EdgeActionVersion version.

az edge-action version update [--add]
                              [--edge-action-name]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--name --version]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]
                              [--tags]

Examples

UpdateEdgeActionVersion

az edge-action version update --resource-group testrg --edge-action-name edgeAction1 --version version2 --location global --deployment-type zip --is-default-version True

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

--edge-action-name

The name of the Edge Action.

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

--name --version -n

The name of the Edge Action version.

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

--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:	Resource 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 edge-action version wait

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

az edge-action version wait [--created]
                            [--custom]
                            [--deleted]
                            [--edge-action-name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--name --version]
                            [--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.

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

--edge-action-name

The name of the Edge Action.

Property	Value
Parameter group:	Resource Id Arguments

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

--name --version -n

The name of the Edge Action version.

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

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

Feedback

Was this page helpful?

Share via

az edge-action version

Commands

az edge-action version create

Examples

Required Parameters

Optional Parameters

az edge-action version delete

Examples

Optional Parameters

az edge-action version deploy-from-file

Examples

Required Parameters

Optional Parameters

az edge-action version deploy-version-code

Examples

Required Parameters

Optional Parameters

az edge-action version get-version-code

Examples

Optional Parameters

az edge-action version list

Examples

Required Parameters

Optional Parameters

az edge-action version show

Examples

Optional Parameters

az edge-action version swap-default

Examples

Optional Parameters

az edge-action version update

Examples

Optional Parameters

az edge-action version wait

Optional Parameters

Feedback