az deploymentmanager service-topology

  • Reference

Manage service topologies.

Commands

az deploymentmanager service-topology create

Creates a service topology.
az deploymentmanager service-topology delete

Deletes the service topology.
az deploymentmanager service-topology list

List all service topologies in a resource group.
az deploymentmanager service-topology show

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

Updates the service topology.

az deploymentmanager service-topology create

Edit

Creates a service topology.

az deploymentmanager service-topology create --location
                                             --name
                                             --resource-group
                                             [--artifact-source]
                                             [--subscription]
                                             [--tags]

Examples

Create a new service topology.

az deploymentmanager service-topology create -g rg1 -l topologyLocation -n contosoServiceTopology --artifact-source /subscriptions/mySub/resourcegroups/rg1/providers/Microsoft.DeploymentManager/artifactSources/contosoWebAppArtifactSource

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

The name of the service topology.

--resource-group -g

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

Optional Parameters

--artifact-source

The name or resource identifier of the artifact source.

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

Edit

Deletes the service topology.

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

Examples

Deletes a service topology.

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

Required Parameters

--name --service-topology-name -n

The name of the service topology.

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

Edit

List all service topologies in a resource group.

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

Examples

List all the service topologies in the resource group.

az deploymentmanager service-topology 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 service-topology show

Edit

Get the details of a service topology.

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

Examples

Get the service topology.

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

Required Parameters

--name --service-topology-name -n

The name of the service topology.

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

Edit

Updates the service topology.

az deploymentmanager service-topology update --name
                                             --resource-group
                                             [--add]
                                             [--artifact-source]
                                             [--force-string]
                                             [--remove]
                                             [--set]
                                             [--subscription]
                                             [--tags]

Examples

Updates the service topology.

az deploymentmanager service-topology update -g rg1 -n contosoServiceTopology --artifact-source /subscriptions/mySub/resourcegroups/rg1/providers/Microsoft.DeploymentManager/artifactSources/contosoWebAppArtifactSource

Required Parameters

--name --service-topology-name -n

The name of the service topology.

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

--artifact-source

The name or resource identifier of the artifact source.

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