network_connections

Creates, updates, deletes, gets or lists a network_connections resource.

Overview

Name	network_connections
Type	Resource
Id	azure.devcenter.network_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
domainJoinType	string	AAD Join type. Known values are: "HybridAzureADJoin" and "AzureADJoin".
domainName	string	Active Directory domain name.
domainPassword	string	The password for the account used to join domain.
domainUsername	string	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.
healthCheckStatus	string	Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
location	string	The geo-location where the resource lives. Required.
networkingResourceGroupName	string	The name for resource group where NICs will be placed.
organizationUnit	string	Active Directory domain Organization Unit (OU).
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
subnetId	string	The subnet to attach Virtual Machines to.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
domainJoinType	string	AAD Join type. Known values are: "HybridAzureADJoin" and "AzureADJoin".
domainName	string	Active Directory domain name.
domainPassword	string	The password for the account used to join domain.
domainUsername	string	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.
healthCheckStatus	string	Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
location	string	The geo-location where the resource lives. Required.
networkingResourceGroupName	string	The name for resource group where NICs will be placed.
organizationUnit	string	Active Directory domain Organization Unit (OU).
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
subnetId	string	The subnet to attach Virtual Machines to.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
domainJoinType	string	AAD Join type. Known values are: "HybridAzureADJoin" and "AzureADJoin".
domainName	string	Active Directory domain name.
domainPassword	string	The password for the account used to join domain.
domainUsername	string	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.
healthCheckStatus	string	Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
location	string	The geo-location where the resource lives. Required.
networkingResourceGroupName	string	The name for resource group where NICs will be placed.
organizationUnit	string	Active Directory domain Organization Unit (OU).
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
subnetId	string	The subnet to attach Virtual Machines to.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_connection_name, subscription_id		Gets a network connection resource.
list_by_resource_group	select	resource_group_name, subscription_id	$top	Lists network connections in a resource group.
list_by_subscription	select	subscription_id	$top	Lists network connections in a subscription.
create_or_update	insert	resource_group_name, network_connection_name, subscription_id, location		Creates or updates a Network Connections resource.
update	update	resource_group_name, network_connection_name, subscription_id		Partially updates a Network Connection.
create_or_update	replace	resource_group_name, network_connection_name, subscription_id, location		Creates or updates a Network Connections resource.
delete	delete	resource_group_name, network_connection_name, subscription_id		Deletes a Network Connections resource.
list_health_details	exec	resource_group_name, network_connection_name, subscription_id	$top	Lists health check status details.
list_outbound_network_dependencies_endpoints	exec	resource_group_name, network_connection_name, subscription_id	$top	Lists 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.
get_health_details	exec	resource_group_name, network_connection_name, subscription_id		Gets health check status details.
run_health_checks	exec	resource_group_name, network_connection_name, subscription_id		Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
network_connection_name	string	Name of the Network Connection that can be applied to a Pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a network connection resource.

SELECT
id,
name,
domainJoinType,
domainName,
domainPassword,
domainUsername,
healthCheckStatus,
location,
networkingResourceGroupName,
organizationUnit,
provisioningState,
subnetId,
systemData,
tags,
type
FROM azure.devcenter.network_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_connection_name = '{{ network_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists network connections in a resource group.

SELECT
id,
name,
domainJoinType,
domainName,
domainPassword,
domainUsername,
healthCheckStatus,
location,
networkingResourceGroupName,
organizationUnit,
provisioningState,
subnetId,
systemData,
tags,
type
FROM azure.devcenter.network_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Lists network connections in a subscription.

SELECT
id,
name,
domainJoinType,
domainName,
domainPassword,
domainUsername,
healthCheckStatus,
location,
networkingResourceGroupName,
organizationUnit,
provisioningState,
subnetId,
systemData,
tags,
type
FROM azure.devcenter.network_connections
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a Network Connections resource.

INSERT INTO azure.devcenter.network_connections (
tags,
location,
properties,
resource_group_name,
network_connection_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_connections resource.
  - name: network_connection_name
    value: "{{ network_connection_name }}"
    description: Required parameter for the network_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_connections resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      subnetId: "{{ subnetId }}"
      domainName: "{{ domainName }}"
      organizationUnit: "{{ organizationUnit }}"
      domainUsername: "{{ domainUsername }}"
      domainPassword: "{{ domainPassword }}"
      networkingResourceGroupName: "{{ networkingResourceGroupName }}"
      domainJoinType: "{{ domainJoinType }}"

UPDATE examples

update

Partially updates a Network Connection.

UPDATE azure.devcenter.network_connections
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_connection_name = '{{ network_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Network Connections resource.

REPLACE azure.devcenter.network_connections
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_connection_name = '{{ network_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Network Connections resource.

DELETE FROM azure.devcenter.network_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_connection_name = '{{ network_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_health_details

Lists health check status details.

EXEC azure.devcenter.network_connections.list_health_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_connection_name='{{ network_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$top='{{ $top }}'
;

list_outbound_network_dependencies_endpoints

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

EXEC azure.devcenter.network_connections.list_outbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_connection_name='{{ network_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$top='{{ $top }}'
;

get_health_details

Gets health check status details.

EXEC azure.devcenter.network_connections.get_health_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_connection_name='{{ network_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

run_health_checks

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

EXEC azure.devcenter.network_connections.run_health_checks 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_connection_name='{{ network_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;