az connectedmachine application

Note

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

Manage Application.

Commands

Name Description Type Status
az connectedmachine application add

Create a VM application.

Extension GA
az connectedmachine application delete

Delete a VM application.

Extension GA
az connectedmachine application instance

Manage Instance View.

Extension GA
az connectedmachine application instance show

Get the instance view of a VM application.

Extension GA
az connectedmachine application list

List the VM applications installed on a hybrid machine.

Extension GA
az connectedmachine application show

Get a VM application.

Extension GA
az connectedmachine application update

Update a VM application.

Extension GA
az connectedmachine application wait

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

Extension GA

az connectedmachine application add

Create a VM application.

az connectedmachine application add [--acquire-policy-token]
                                    [--application-name --name]
                                    [--change-reference]
                                    [--community-gallery-application-id --gallery-id]
                                    [--config-reference --configuration-reference]
                                    [--deployment-failure --treat-failure-as-deployment-failure {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--location]
                                    [--machine-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--order]
                                    [--package-id --package-reference-id]
                                    [--resource-group]
                                    [--shared-app-id --shared-gallery-application-id]
                                    [--subscription]
                                    [--tags]

Examples

Sample command for application add

az connectedmachine application add --resource-group myResourceGroup --machine-name myMachine --application-name myApplication --location eastus2euap --tags "{environment:production}" --order 1 --package-reference-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/galleryResourceGroup/providers/Microsoft.Compute/galleries/myGallery/applications/myApplication/versions/1.0.0 --treat-failure-as-deployment-failure 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--application-name --name -n

The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.

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
--community-gallery-application-id --gallery-id

The identifier of a community gallery application version. Use /communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId.

Property Value
Parameter group: Properties Arguments
--config-reference --configuration-reference

The URI of configuration data that replaces the package's default configuration.

Property Value
Parameter group: Properties Arguments
--deployment-failure --treat-failure-as-deployment-failure

Indicates whether an application operation failure causes the deployment to fail.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--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
--machine-name

The name of the hybrid machine.

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

The order in which the application is installed.

Property Value
Parameter group: Properties Arguments
--package-id --package-reference-id

The resource ID of the gallery application version. The version name can be latest or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId.

Property Value
Parameter group: Properties 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
--shared-app-id --shared-gallery-application-id

The identifier of a direct shared gallery application version. Use /sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId.

Property Value
Parameter group: Properties 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 connectedmachine application delete

Delete a VM application.

az connectedmachine application delete [--acquire-policy-token]
                                       [--application-name --name]
                                       [--change-reference]
                                       [--ids]
                                       [--machine-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

Examples

Sample command for application delete

az connectedmachine application delete --resource-group myResourceGroup --machine-name myMachine --application-name myApplication

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
--application-name --name -n

The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.

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

The name of the hybrid machine.

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 connectedmachine application list

List the VM applications installed on a hybrid machine.

az connectedmachine application list --machine-name
                                     --resource-group
                                     [--max-items]
                                     [--next-token]
                                     [--skip-token]
                                     [--top]

Examples

Sample command for application list

az connectedmachine application list --machine-name "testMachine" -g "testRG"

Required Parameters

--machine-name

The name of the hybrid machine.

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

The continuation token for the next page of results.

--top

The maximum number of results to return.

Property Value
Default value: 100
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 connectedmachine application show

Get a VM application.

az connectedmachine application show [--application-name --name]
                                     [--ids]
                                     [--machine-name]
                                     [--resource-group]
                                     [--subscription]

Examples

Sample command for application show

az connectedmachine application show --resource-group myResourceGroup --machine-name myMachine --application-name myApplication

Optional Parameters

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

--application-name --name -n

The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.

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

The name of the hybrid machine.

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 connectedmachine application update

Update a VM application.

az connectedmachine application update [--acquire-policy-token]
                                       [--add]
                                       [--application-name --name]
                                       [--change-reference]
                                       [--community-gallery-application-id --gallery-id]
                                       [--config-reference --configuration-reference]
                                       [--deployment-failure --treat-failure-as-deployment-failure {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--machine-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--order]
                                       [--package-id --package-reference-id]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--shared-app-id --shared-gallery-application-id]
                                       [--subscription]
                                       [--tags]

Examples

Sample command for application update

az connectedmachine application update --resource-group myResourceGroup --machine-name myMachine --application-name myApplication --tags "{environment:production}" --order 1 --package-reference-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/galleryResourceGroup/providers/Microsoft.Compute/galleries/myGallery/applications/myApplication/versions/1.0.0 --treat-failure-as-deployment-failure 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

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

The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.

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
--community-gallery-application-id --gallery-id

The identifier of a community gallery application version. Use /communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId.

Property Value
Parameter group: Properties Arguments
--config-reference --configuration-reference

The URI of configuration data that replaces the package's default configuration.

Property Value
Parameter group: Properties Arguments
--deployment-failure --treat-failure-as-deployment-failure

Indicates whether an application operation failure causes the deployment to fail.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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

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

The name of the hybrid machine.

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

The order in which the application is installed.

Property Value
Parameter group: Properties Arguments
--package-id --package-reference-id

The resource ID of the gallery application version. The version name can be latest or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId.

Property Value
Parameter group: Properties Arguments
--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
--shared-app-id --shared-gallery-application-id

The identifier of a direct shared gallery application version. Use /sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId.

Property Value
Parameter group: Properties 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 connectedmachine application wait

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

az connectedmachine application wait [--acquire-policy-token]
                                     [--application-name --name]
                                     [--change-reference]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--machine-name]
                                     [--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
--application-name --name -n

The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.

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

The name of the hybrid machine.

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