az deploymentmanager service-unit

  • Reference

Manage the service units.

Service units combine to form a service in a service topology.

Commands

az deploymentmanager service-unit create

Creates a service unit under the specified service and service topology.
az deploymentmanager service-unit delete

Deletes the service unit.
az deploymentmanager service-unit list

List all service units in a service.
az deploymentmanager service-unit show

Get the details of a service unit.
az deploymentmanager service-unit update

Updates the service unit.

az deploymentmanager service-unit create

Edit

Creates a service unit under the specified service and service topology.

az deploymentmanager service-unit create --deployment-mode {Complete, Incremental}
                                         --name
                                         --parameters-path
                                         --resource-group
                                         --service-name
                                         --service-topology-name
                                         --target-resource-group
                                         --template-path
                                         [--location]
                                         [--subscription]
                                         [--tags]

Examples

Create a new service unit using relative paths into the artifact source.

az deploymentmanager service-unit create -g rg1 -l location --service-topology-name contosoServiceTopology --service-name contosoService1 -n ContosoService1Storage --target-resource-group service1ResourceGroup --deployment-mode Incremental --template-path "Templates/Service1.Storage.json" --parameters-path "Parameters/Service1.Storage.Parameters.json"

Create a new service unit using SAS Uri for template and parameters.

az deploymentmanager service-unit create -g rg1 -l location --service-topology-name contosoServiceTopology --service-name contosoService1 -n ContosoService1Storage \
    --target-resource-group service1ResourceGroup --deployment-mode Incremental \
    --template-path "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Templates/Service2.Storage.json?sasParameters" \
    --parameters-path "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Parameters/Service2Storage.Parameters.json?sasParameters"

Required Parameters

--deployment-mode

The type of depoyment mode to be used when deploying the service unit. Possible values: Incremental, Complete.

accepted values: Complete, Incremental
default value: DeploymentMode.incremental
--name --service-unit-name -n

The name of the service unit.

--parameters-path

The path to the ARM parameters file. Either the full SAS Uri or the relative path in the artifact source for this topology.

--resource-group -g

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

--service-name

The name of the service.

--service-topology-name

The name of the service topology.

--target-resource-group

The resource group where the resources in the service unit should be deployed to.

--template-path

The path to the ARM template file. Either the full SAS Uri or the relative path in the artifact source for this topology.

Optional Parameters

--location -l

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

--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 service-unit delete

Edit

Deletes the service unit.

az deploymentmanager service-unit delete --name
                                         --resource-group
                                         --service-name
                                         --service-topology-name
                                         [--subscription]

Examples

Deletes a service unit.

az deploymentmanager service-unit delete -g rg1 --service-topology-name contosoServiceTopology --service-name contosoService1 -n ContosoService1Storage

Required Parameters

--name --service-unit-name -n

The name of the service unit.

--resource-group -g

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

--service-name

The name of the service.

--service-topology-name

The name of the service topology.

Optional Parameters

--subscription

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

az deploymentmanager service-unit list

Edit

List all service units in a service.

az deploymentmanager service-unit list --resource-group
                                       --service-name
                                       --service-topology-name
                                       [--query-examples]
                                       [--subscription]

Examples

List the service units in the given service topology and service.

az deploymentmanager service-unit list -g rg1 --service-topology-name contosoServiceTopology --service-name contosoService1

Required Parameters

--resource-group -g

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

--service-name

The name of the service.

--service-topology-name

The name of the service topology.

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 service-unit show

Edit

Get the details of a service unit.

az deploymentmanager service-unit show --name
                                       --resource-group
                                       --service-name
                                       --service-topology-name
                                       [--query-examples]
                                       [--subscription]

Examples

Get the service unit.

az deploymentmanager service-unit show -g rg1 --service-topology-name contosoServiceTopology --service-name contosoService1 -n ContosoService1Storage

Required Parameters

--name --service-unit-name -n

The name of the service unit.

--resource-group -g

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

--service-name

The name of the service.

--service-topology-name

The name of the service topology.

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 service-unit update

Edit

Updates the service unit.

az deploymentmanager service-unit update --name
                                         --resource-group
                                         --service-name
                                         --service-topology-name
                                         [--add]
                                         [--deployment-mode {Complete, Incremental}]
                                         [--force-string]
                                         [--parameters-path]
                                         [--remove]
                                         [--set]
                                         [--subscription]
                                         [--tags]
                                         [--target-resource-group]
                                         [--template-path]

Examples

Updates the service unit.

az deploymentmanager service-unit update -g rg1 --service-topology-name contosoServiceTopology --service-name contosoService1 -n ContosoService1Storage --target-resource-group service1ResourceGroupUpdated

Updates the service unit. (autogenerated)

az deploymentmanager service-unit update --deployment-mode Incremental --resource-group rg1 --service-name contosoService1 --service-topology-name contosoServiceTopology --service-unit-name ContosoService1Storage

Required Parameters

--name --service-unit-name -n

The name of the service unit.

--resource-group -g

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

--service-name

The name of the service.

--service-topology-name

The name of the service topology.

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

--deployment-mode

The type of depoyment mode to be used when deploying the service unit. Possible values: Incremental, Complete.

accepted values: Complete, Incremental
default value: DeploymentMode.incremental
--force-string

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

--parameters-path

The path to the ARM parameters file. Either the full SAS Uri or the relative path in the artifact source for this topology.

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

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

--target-resource-group

The resource group where the resources in the service unit should be deployed to.

--template-path

The path to the ARM template file. Either the full SAS Uri or the relative path in the artifact source for this topology.