az devcenter admin network-connection

Note

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

Manage network connections.

Commands

Name	Description	Type	Status
az devcenter admin network-connection create	Create a network connection.	Extension	GA
az devcenter admin network-connection delete	Delete a network connection.	Extension	GA
az devcenter admin network-connection list	List network connections.	Extension	GA
az devcenter admin network-connection list-health-check	List health check status details.	Extension	GA
az devcenter admin network-connection list-outbound-network-dependencies-endpoint	List the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.	Extension	GA
az devcenter admin network-connection run-health-check	Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details.	Extension	GA
az devcenter admin network-connection show	Get a network connection.	Extension	GA
az devcenter admin network-connection show-health-check	Get health check status details.	Extension	GA
az devcenter admin network-connection update	Update a Network Connection.	Extension	GA
az devcenter admin network-connection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az devcenter admin network-connection create

Create a network connection.

az devcenter admin network-connection create --domain-join-type {AzureADJoin, HybridAzureADJoin, None}
                                             --name --network-connection-name
                                             --resource-group
                                             --subnet-id
                                             [--domain-name]
                                             [--domain-password]
                                             [--domain-username]
                                             [--location]
                                             [--networking-resource-group-name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--organization-unit]
                                             [--tags]

Examples

Create hybrid join

az devcenter admin network-connection create --location "eastus" --domain-join-type "HybridAzureADJoin" --domain-name "mydomaincontroller.local" --domain-password "Password value for user" --domain-username "testuser@mydomaincontroller.local" --subnet-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" --name "uswest3network" --resource-group "rg1"

Create Azure AD join

az devcenter admin network-connection create --location "eastus" --domain-join-type "AzureADJoin" --networking-resource-group-name "NetworkInterfacesRG" --subnet-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" --name "uswest3network" --resource-group "rg1"

Required Parameters

--domain-join-type

AAD Join type.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	AzureADJoin, HybridAzureADJoin, None

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

--resource-group -g

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

--subnet-id

The subnet to attach dev boxes to.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

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

--domain-name

Active Directory domain name.

Property	Value
Parameter group:	Properties Arguments

--domain-password

The password for the account used to join domain. If value is blank it's asked from the tty.

Property	Value
Parameter group:	Properties Arguments

--domain-username

The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Body Arguments

--networking-resource-group-name -r

The name for resource group where NICs will be placed.

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

--organization-unit

Active Directory domain Organization Unit (OU).

Property	Value
Parameter group:	Properties Arguments

--tags

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

Property	Value
Parameter group:	Body 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 devcenter admin network-connection delete

Delete a network connection.

az devcenter admin network-connection delete [--ids]
                                             [--name --network-connection-name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]

Examples

Delete

az devcenter admin network-connection delete --name "uswest3network" --resource-group "rg1"

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 --network-connection-name -n

Name of the network connection that can be applied to a pool.

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 devcenter admin network-connection list

List network connections.

az devcenter admin network-connection list [--max-items]
                                           [--next-token]
                                           [--resource-group]

Examples

List by resource group

az devcenter admin network-connection list --resource-group "rg1"

List by subscription

az devcenter admin network-connection list

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

--resource-group -g

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

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 devcenter admin network-connection list-health-check

List health check status details.

az devcenter admin network-connection list-health-check --name --network-connection-name
                                                        --resource-group
                                                        [--max-items]
                                                        [--next-token]

Examples

List health check status details

az devcenter admin network-connection list-health-check --name "uswest3network" --resource-group "rg1"

Required Parameters

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

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

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 devcenter admin network-connection list-outbound-network-dependencies-endpoint

List the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.

az devcenter admin network-connection list-outbound-network-dependencies-endpoint --name --network-connection-name
                                                                                  --resource-group
                                                                                  [--max-items]
                                                                                  [--next-token]

Examples

List outbound network dependencies endpoint

az devcenter admin network-connection list-outbound-network-dependencies-endpoint --name "uswest3network" --resource-group "rg1"

Required Parameters

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

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

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 devcenter admin network-connection run-health-check

Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details.

az devcenter admin network-connection run-health-check [--ids]
                                                       [--name --network-connection-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--subscription]

Examples

Run health check

az devcenter admin network-connection run-health-check --name "uswest3network" --resource-group "rg1"

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

Property	Value
Parameter group:	Resource Id Arguments

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

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

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 devcenter admin network-connection show

Get a network connection.

az devcenter admin network-connection show [--ids]
                                           [--name --network-connection-name]
                                           [--resource-group]
                                           [--subscription]

Examples

Get

az devcenter admin network-connection show --name "uswest3network" --resource-group "rg1"

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

Property	Value
Parameter group:	Resource Id Arguments

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

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 devcenter admin network-connection show-health-check

Get health check status details.

az devcenter admin network-connection show-health-check [--ids]
                                                        [--name --network-connection-name]
                                                        [--resource-group]
                                                        [--subscription]

Examples

Get health check

az devcenter admin network-connection show-health-check--name "uswest3network" --resource-group "rg1"

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

Property	Value
Parameter group:	Resource Id Arguments

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

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 devcenter admin network-connection update

Update a Network Connection.

az devcenter admin network-connection update [--domain-name]
                                             [--domain-password]
                                             [--domain-username]
                                             [--ids]
                                             [--name --network-connection-name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--organization-unit]
                                             [--resource-group]
                                             [--subnet-id]
                                             [--subscription]
                                             [--tags]

Examples

Update

az devcenter admin network-connection update --domain-password "New Password value for user" --name "networkConnection" --resource-group "rg1"

Optional Parameters

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

--domain-name

Active Directory domain name.

Property	Value
Parameter group:	Properties Arguments

--domain-password

The password for the account used to join domain.

Property	Value
Parameter group:	Properties Arguments

--domain-username

The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --network-connection-name -n

Name of the Network Connection that can be applied to a Pool.

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

--organization-unit

Active Directory domain Organization Unit (OU).

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

--subnet-id

The subnet to attach Virtual Machines to.

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

--tags

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

Property	Value
Parameter group:	Body 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 devcenter admin network-connection wait

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

az devcenter admin network-connection wait [--created]
                                           [--custom]
                                           [--deleted]
                                           [--exists]
                                           [--ids]
                                           [--interval]
                                           [--name --network-connection-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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --network-connection-name -n

Name of the network connection that can be applied to a pool.

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

Share via

az devcenter admin network-connection

Commands

az devcenter admin network-connection create

Examples

Required Parameters

Optional Parameters

az devcenter admin network-connection delete

Examples

Optional Parameters

az devcenter admin network-connection list

Examples

Optional Parameters

az devcenter admin network-connection list-health-check

Examples

Required Parameters

Optional Parameters

az devcenter admin network-connection list-outbound-network-dependencies-endpoint

Examples

Required Parameters

Optional Parameters

az devcenter admin network-connection run-health-check

Examples

Optional Parameters

az devcenter admin network-connection show

Examples

Optional Parameters

az devcenter admin network-connection show-health-check

Examples

Optional Parameters

az devcenter admin network-connection update

Examples

Optional Parameters

az devcenter admin network-connection wait

Optional Parameters

Feedback