az deploymentmanager rollout

Manage the rollouts.

View progress, restart a failed rollout, stop a running rollout. Rollouts can be created using the 'az group deployment' command.

Commands

az deploymentmanager rollout delete

Deletes a rollout resource.

az deploymentmanager rollout list

List all rollouts in a resource group.

az deploymentmanager rollout restart

Restarts the rollout.

az deploymentmanager rollout show

Gets the rollout.

az deploymentmanager rollout stop

Stop the rollout.

az deploymentmanager rollout delete

Deletes a rollout resource.

Only rollouts in terminal state can be deleted.

az deploymentmanager rollout delete --name
                                    --resource-group
                                    [--subscription]

Required Parameters

--name --rollout-name -n

The name of the rollout.

--resource-group -g

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

Optional Parameters

--subscription

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

az deploymentmanager rollout list

List all rollouts in a resource group.

az deploymentmanager rollout list --resource-group
                                  [--query-examples]
                                  [--subscription]

Examples

List all rollouts in the resource group

az deploymentmanager rollout list -g rg1

Required Parameters

--resource-group -g

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az deploymentmanager rollout restart

Restarts the rollout.

az deploymentmanager rollout restart --name
                                     --resource-group
                                     [--skip-succeeded]
                                     [--subscription]
                                     [--yes]

Examples

Restart the rollout

az deploymentmanager rollout restart -g rg1 -n contosoServiceRollout

Restart the rollout and skip all steps that have succeeded in the previous run

az deploymentmanager rollout restart -g rg1 -n contosoServiceRollout --skip-succeeded

Required Parameters

--name --rollout-name -n

The name of the rollout.

--resource-group -g

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

Optional Parameters

--skip-succeeded

Skips all the steps that have succeeded in the previous retries of this rollout.

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

az deploymentmanager rollout show

Gets the rollout.

az deploymentmanager rollout show --name
                                  --resource-group
                                  [--query-examples]
                                  [--retry-attempt]
                                  [--subscription]

Examples

Gets the rollout

az deploymentmanager rollout show -g rg1 -n contosoServiceRollout

Gets the specific retry attempt of a rollout. Shows the steps run during that attempt.

az deploymentmanager rollout show -g rg1 -n contosoServiceRollout --retry-attempt 1

Required Parameters

--name --rollout-name -n

The name of the rollout.

--resource-group -g

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--retry-attempt

Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.

--subscription

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

az deploymentmanager rollout stop

Stop the rollout.

az deploymentmanager rollout stop --name
                                  --resource-group
                                  [--subscription]
                                  [--yes]

Examples

Stops the rollout

az deploymentmanager rollout stop -g rg1 -n contosoServiceRollout

Required Parameters

--name --rollout-name -n

The name of the rollout.

--resource-group -g

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

Optional Parameters

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