Share via

az workload-orchestration context site-reference

Note

This reference is part of the workload-orchestration extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az workload-orchestration context site-reference command. Learn more about extensions.

Manage workload orchestration site reference context.

Commands

Name Description Type Status
az workload-orchestration context site-reference create

Create Site Reference Resource.

 Extension GA
az workload-orchestration context site-reference delete

Delete Site Reference Resource.

 Extension GA
az workload-orchestration context site-reference list

List Site Reference Resources.

 Extension GA
az workload-orchestration context site-reference show

Get Site Reference Resource.

 Extension GA
az workload-orchestration context site-reference wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az workload-orchestration context site-reference create

Create Site Reference Resource.

az workload-orchestration context site-reference create --context-name
                                                        --name --site-reference-name
                                                        --resource-group
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--site-id]

Examples

Create a Site Reference

az workload-orchestration context site-reference create -g {rg} -n {site_reference_name} --context-name {context_name} --site-id {site_id}

Required Parameters

--context-name

The name of the Context.

--name --site-reference-name -n

The name of the SiteReference.

--resource-group -g

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

Optional Parameters

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

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--site-id

Azure Resource ID for Site.

Property Value
Parameter group: Properties 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 context site-reference delete

Delete Site Reference Resource.

az workload-orchestration context site-reference delete [--context-name]
                                                        [--ids]
                                                        [--name --site-reference-name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--yes]

Examples

Delete a Site Reference

az workload-orchestration context site-reference delete -n mySiteReference -g myResourceGroup --context-name myContext

Optional Parameters

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

--context-name

The name of the Context.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --site-reference-name -n

The name of the SiteReference.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

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

Property Value
Default value: False

az workload-orchestration context site-reference list

List Site Reference Resources.

az workload-orchestration context site-reference list --context-name
                                                      --resource-group
                                                      [--max-items]
                                                      [--next-token]

Examples

List Site References

az workload-orchestration context site-reference list --context-name myContext -g myResourceGroup

Required Parameters

--context-name

The name of the Context.

--resource-group -g

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

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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 context site-reference show

Get Site Reference Resource.

az workload-orchestration context site-reference show [--context-name]
                                                      [--ids]
                                                      [--name --site-reference-name]
                                                      [--resource-group]
                                                      [--subscription]

Examples

Show a Site Reference

az workload-orchestration context site-reference show -n mySiteReference -g myResourceGroup --context-name myContext

Optional Parameters

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

--context-name

The name of the Context.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --site-reference-name -n

The name of the SiteReference.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

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

Property Value
Default value: False

az workload-orchestration context site-reference wait

Place the CLI in a waiting state until a condition is met.

az workload-orchestration context site-reference wait [--context-name]
                                                      [--created]
                                                      [--custom]
                                                      [--deleted]
                                                      [--exists]
                                                      [--ids]
                                                      [--interval]
                                                      [--name --site-reference-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--timeout]
                                                      [--updated]

Optional Parameters

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

--context-name

The name of the Context.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --site-reference-name -n

The name of the SiteReference.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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.

--verbose

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

Property Value
Default value: False