az workload-orchestration hierarchy

Note

This command group has commands that are defined in two or more extensions. Each extension will automatically install the first time you run an extension command. Learn more about extensions.

Manage workload-orchestration hierarchies (Site + Configuration + ConfigurationReference).

Commands

Name Description Type Status
az workload-orchestration hierarchy create (workload-orchestration extension)

Create a hierarchy: Site + Configuration + ConfigurationReference (and ServiceGroup ancestors if type=ServiceGroup).

Extension GA
az workload-orchestration hierarchy create (workload-orchestration-preview extension)

Create a hierarchy: Site + Configuration + ConfigurationReference (and ServiceGroup ancestors if type=ServiceGroup).

Extension GA

az workload-orchestration hierarchy create (workload-orchestration extension)

Create a hierarchy: Site + Configuration + ConfigurationReference (and ServiceGroup ancestors if type=ServiceGroup).

Idempotent. Supports ResourceGroup (default, single site) and ServiceGroup (nested, up to 3 levels) hierarchy types.

az workload-orchestration hierarchy create --configuration-location
                                           --hierarchy-spec
                                           --resource-group
                                           [--acquire-policy-token]
                                           [--change-reference]

Examples

Create RG hierarchy from YAML file

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec hierarchy.yaml

Create RG hierarchy with inline shorthand

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec "{name:Mehoopany,level:factory}"

Create ServiceGroup hierarchy from JSON file

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec sg-hierarchy.json

Create ServiceGroup hierarchy with inline shorthand (children as array)

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec "{type:ServiceGroup,name:India,level:country,children:[{name:Karnataka,level:region,children:[{name:BangaloreSouth,level:factory}]}]}"

Required Parameters

--configuration-location -l

Azure region for the Configuration resource (e.g. eastus2euap).

--hierarchy-spec

Hierarchy spec. Required keys: name, level. Optional: type (ResourceGroup|ServiceGroup, default ResourceGroup), children (list of child specs, ServiceGroup only, up to 3 levels deep). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

Resource group for Configuration resources.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az workload-orchestration hierarchy create (workload-orchestration-preview extension)

Create a hierarchy: Site + Configuration + ConfigurationReference (and ServiceGroup ancestors if type=ServiceGroup).

Idempotent. Supports ResourceGroup (default, single site) and ServiceGroup (nested, up to 3 levels) hierarchy types.

az workload-orchestration hierarchy create --configuration-location
                                           --hierarchy-spec
                                           --resource-group
                                           [--acquire-policy-token]
                                           [--change-reference]

Examples

Create RG hierarchy from YAML file

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec hierarchy.yaml

Create RG hierarchy with inline shorthand

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec "{name:Mehoopany,level:factory}"

Create ServiceGroup hierarchy from JSON file

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec sg-hierarchy.json

Create ServiceGroup hierarchy with inline shorthand (children as array)

az workload-orchestration hierarchy create -g my-rg -l eastus2euap --hierarchy-spec "{type:ServiceGroup,name:India,level:country,children:[{name:Karnataka,level:region,children:[{name:BangaloreSouth,level:factory}]}]}"

Required Parameters

--configuration-location -l

Azure region for the Configuration resource (e.g. eastus2euap).

--hierarchy-spec

Hierarchy spec. Required keys: name, level. Optional: type (ResourceGroup|ServiceGroup, default ResourceGroup), children (list of child specs, ServiceGroup only, up to 3 levels deep). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

Resource group for Configuration resources.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False