az deploymentmanager service

Manage the services in a service topology.

Commands

az deploymentmanager service create

Creates a service under the specified service topology.

az deploymentmanager service delete

Deletes the service topology.

az deploymentmanager service list

List all services in a service topology.

az deploymentmanager service show

Get the details of a service.

az deploymentmanager service update

Updates the service.

az deploymentmanager service create

Creates a service under the specified service topology.

az deploymentmanager service create --location
                                    --name
                                    --resource-group
                                    --service-topology-name
                                    --target-location
                                    --target-subscription-id
                                    [--subscription]
                                    [--tags]

Examples

Create a new service under a service topology. Specify the service by its name, service topology it is in and the resource group name.

az deploymentmanager service create -g rg1 -l serviceLocation --service-topology-name contosoServiceTopology -n contosoService1 --target-location "East US" --target-subscription-id XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Required Parameters

--location -l

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

--name --service-name -n

The name of the service.

--resource-group -g

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

--service-topology-name

The name of the service topology.

--target-location

The location where the resources in the service should be deployed to.

--target-subscription-id

The subscription to which the resources in the service should be deployed to.

Optional Parameters

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

Deletes the service topology.

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

Examples

Deletes a service topology.

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

Required Parameters

--name --service-name -n

The name of the service.

--resource-group -g

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

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

List all services in a service topology.

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

Examples

List all the services under the given service topology.

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

Required Parameters

--resource-group -g

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

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

Get the details of a service.

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

Examples

Get the service under a service topology.

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

Required Parameters

--name --service-name -n

The name of the service.

--resource-group -g

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

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

Updates the service.

az deploymentmanager service update --name
                                    --resource-group
                                    --service-topology-name
                                    [--add]
                                    [--force-string]
                                    [--remove]
                                    [--set]
                                    [--subscription]
                                    [--tags]
                                    [--target-location]
                                    [--target-subscription-id]

Examples

Updates the service.

az deploymentmanager service update -g rg1 --service-topology-name contosoServiceTopology -n contosoService1 --target-location "West US" --target-subscription-id XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Required Parameters

--name --service-name -n

The name of the service.

--resource-group -g

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

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

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

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

The location where the resources in the service should be deployed to.

--target-subscription-id

The subscription to which the resources in the service should be deployed to.