az deploymentmanager step

Manage the steps.

Allows you to manage the steps that can be used in rollouts.

Commands

az deploymentmanager step create

Creates the step.

az deploymentmanager step delete

Deletes the step.

az deploymentmanager step list

List all steps in a resource group.

az deploymentmanager step show

Get the details of the step.

az deploymentmanager step update

Updates the step.

az deploymentmanager step create

Creates the step.

az deploymentmanager step create --resource-group
                                 [--duration]
                                 [--location]
                                 [--name]
                                 [--step]
                                 [--subscription]
                                 [--tags]

Examples

Creates a wait step.

az deploymentmanager step create -g rg1 -l location -n contosoServiceWaitStep --duration PT30M

Creates a health check step from a JSON file. The step information is read from the file.

az deploymentmanager step create -g rg1 --step healthcheck_step.json

Required Parameters

--resource-group -g

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

Optional Parameters

--duration

The duration of the wait step in ISO 8601 format.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --step-name -n

The name of the step.

--step

The step object, specify either the path to a json file or provide a json string that forms the step resource. The json is expected to be of the same format as the output of the relevant az deploymentmanager step show command.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az deploymentmanager step delete

Deletes the step.

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

Required Parameters

--name --step-name -n

The name of the step.

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

List all steps in a resource group.

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

Examples

List available steps in the given resource group.

az deploymentmanager step 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 step show

Get the details of the step.

az deploymentmanager step show --name
                               --resource-group
                               [--query-examples]
                               [--subscription]

Examples

Get the step.

az deploymentmanager step show -g rg1 -n contosoServiceWaitStep

Required Parameters

--name --step-name -n

The name of the step.

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

Updates the step.

az deploymentmanager step update --name
                                 --resource-group
                                 [--add]
                                 [--duration]
                                 [--force-string]
                                 [--remove]
                                 [--set]
                                 [--step]
                                 [--subscription]
                                 [--tags]

Examples

Updates a step.

az deploymentmanager step update -g rg1 -n contosoServiceWaitStep --duration PT20M

Required Parameters

--name --step-name -n

The name of the step.

--resource-group -g

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

Optional Parameters

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

--duration

The duration of the wait step in ISO 8601 format.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--step

The step object, specify either the path to a json file or provide a json string that forms the step resource. The json is expected to be of the same format as the output of the relevant az deploymentmanager step show command.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.