az dnc orchestrator-instance-service

Note

This reference is part of the dnc extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az dnc orchestrator-instance-service command. Learn more about extensions.

Command group 'az dnc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage orchestrator instance service with dnc.

Commands

Name	Description	Type	Status
az dnc orchestrator-instance-service create	Create a orchestrator instance.	Extension	Preview
az dnc orchestrator-instance-service delete	Delete the Orchestrator Instance.	Extension	Preview
az dnc orchestrator-instance-service show	Get details about the orchestrator instance.	Extension	Preview
az dnc orchestrator-instance-service wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az dnc orchestrator-instance-service create

Preview

Command group 'az dnc orchestrator-instance-service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a orchestrator instance.

az dnc orchestrator-instance-service create --name --resource-name
                                            --resource-group
                                            [--api-server-endpoint]
                                            [--cluster-root-ca]
                                            [--id]
                                            [--kind {Kubernetes}]
                                            [--location]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--orchestrator-app-id]
                                            [--orchestrator-tenant-id]
                                            [--priv-link-resource-id]
                                            [--tags]
                                            [--type {None, SystemAssigned}]

Examples

Create an orchestrator instance

az dnc orchestrator-instance-service create --type "SystemAssigned" --location "West US" --kind "Kubernetes" --api-server-endpoint "https://testk8s.cloudapp.net" --cluster-root-ca "ddsadsad344mfdsfdl" --id "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" --orchestrator-app-id "546192d7-503f-477a-9cfe-4efc3ee2b6e1" --orchestrator-tenant-id "da6192d7-503f-477a-9cfe-4efc3ee2b6c3" --priv-link-resource-id "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/privateLinkServices/plresource1" --resource-group "TestRG" --resource-name "testk8s1"

Required Parameters

--name --resource-name -n

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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

--api-server-endpoint

K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified.

Property	Value
Parameter group:	Properties Arguments

--cluster-root-ca

RootCA certificate of kubernetes cluster base64 encoded.

Property	Value
Parameter group:	Properties Arguments

--id

Controller arm resource id.

Property	Value
Parameter group:	ControllerDetails Arguments

--kind

The kind of workbook. Choices are user and shared.

Property	Value
Parameter group:	Parameters Arguments
Default value:	Kubernetes
Accepted values:	Kubernetes

--location -l

Location of the resource.

Property	Value
Parameter group:	Parameters 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

--orchestrator-app-id

AAD ID used with apiserver.

Property	Value
Parameter group:	Properties Arguments

--orchestrator-tenant-id

TenantID of server App ID.

Property	Value
Parameter group:	Properties Arguments

--priv-link-resource-id

Private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified.

Property	Value
Parameter group:	Properties Arguments

--tags

The resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--type

The type of identity used for orchestrator cluster. Type 'SystemAssigned' will use an implicitly created identity orchestrator clusters.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	None, SystemAssigned

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 dnc orchestrator-instance-service delete

Preview

Command group 'az dnc orchestrator-instance-service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the Orchestrator Instance.

az dnc orchestrator-instance-service delete [--force-delete {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--ids]
                                            [--name --resource-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

Examples

Delete an orchestrator instance

az dnc orchestrator-instance-service delete --resource-group "TestRG" --resource-name "testk8s1"

Optional Parameters

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

--force-delete

Force delete resource.

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

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

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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 dnc orchestrator-instance-service show

Preview

Command group 'az dnc orchestrator-instance-service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get details about the orchestrator instance.

az dnc orchestrator-instance-service show [--ids]
                                          [--name --resource-name]
                                          [--resource-group]
                                          [--subscription]

Examples

Get details of an orchestrator instance

az dnc orchestrator-instance-service show --resource-group "TestRG" --resource-name "testk8s1"

Optional Parameters

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

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

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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 dnc orchestrator-instance-service wait

Preview

Command group 'az dnc orchestrator-instance-service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az dnc orchestrator-instance-service wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--name --resource-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.

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

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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