attached_networks

Creates, updates, deletes, gets or lists an attached_networks resource.

Overview

Name	attached_networks
Type	Resource
Id	azure.devcenter.attached_networks

Fields

The following fields are returned by SELECT queries:

get_by_dev_center

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 of the network. This is populated based on the referenced Network Connection. Known values are: "HybridAzureADJoin" and "AzureADJoin".
healthCheckStatus	string	Health check status values. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
networkConnectionId	string	The resource ID of the NetworkConnection you want to attach.
networkConnectionLocation	string	The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.
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".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_project

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 of the network. This is populated based on the referenced Network Connection. Known values are: "HybridAzureADJoin" and "AzureADJoin".
healthCheckStatus	string	Health check status values. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
networkConnectionId	string	The resource ID of the NetworkConnection you want to attach.
networkConnectionLocation	string	The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.
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".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_project

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 of the network. This is populated based on the referenced Network Connection. Known values are: "HybridAzureADJoin" and "AzureADJoin".
healthCheckStatus	string	Health check status values. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
networkConnectionId	string	The resource ID of the NetworkConnection you want to attach.
networkConnectionLocation	string	The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.
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".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_dev_center

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 of the network. This is populated based on the referenced Network Connection. Known values are: "HybridAzureADJoin" and "AzureADJoin".
healthCheckStatus	string	Health check status values. Known values are: "Unknown", "Pending", "Running", "Passed", "Warning", and "Failed".
networkConnectionId	string	The resource ID of the NetworkConnection you want to attach.
networkConnectionLocation	string	The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.
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".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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_by_dev_center	select	resource_group_name, dev_center_name, attached_network_connection_name, subscription_id		Gets an attached NetworkConnection.
get_by_project	select	resource_group_name, project_name, attached_network_connection_name, subscription_id		Gets an attached NetworkConnection.
list_by_project	select	resource_group_name, project_name, subscription_id	$top	Lists the attached NetworkConnections for a Project.
list_by_dev_center	select	resource_group_name, dev_center_name, subscription_id	$top	Lists the attached NetworkConnections for a DevCenter.
create_or_update	insert	resource_group_name, dev_center_name, attached_network_connection_name, subscription_id		Creates or updates an attached NetworkConnection.
create_or_update	replace	resource_group_name, dev_center_name, attached_network_connection_name, subscription_id		Creates or updates an attached NetworkConnection.
delete	delete	resource_group_name, dev_center_name, attached_network_connection_name, subscription_id		Un-attach a NetworkConnection.

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
attached_network_connection_name	string	The name of the attached NetworkConnection. Required.
dev_center_name	string	The name of the devcenter. Required.
project_name	string	The name of the project. 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_by_dev_center

Gets an attached NetworkConnection.

SELECT
id,
name,
domainJoinType,
healthCheckStatus,
networkConnectionId,
networkConnectionLocation,
provisioningState,
systemData,
type
FROM azure.devcenter.attached_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND attached_network_connection_name = '{{ attached_network_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_by_project

Gets an attached NetworkConnection.

SELECT
id,
name,
domainJoinType,
healthCheckStatus,
networkConnectionId,
networkConnectionLocation,
provisioningState,
systemData,
type
FROM azure.devcenter.attached_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND attached_network_connection_name = '{{ attached_network_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_project

Lists the attached NetworkConnections for a Project.

SELECT
id,
name,
domainJoinType,
healthCheckStatus,
networkConnectionId,
networkConnectionLocation,
provisioningState,
systemData,
type
FROM azure.devcenter.attached_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_dev_center

Lists the attached NetworkConnections for a DevCenter.

SELECT
id,
name,
domainJoinType,
healthCheckStatus,
networkConnectionId,
networkConnectionLocation,
provisioningState,
systemData,
type
FROM azure.devcenter.attached_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an attached NetworkConnection.

INSERT INTO azure.devcenter.attached_networks (
properties,
resource_group_name,
dev_center_name,
attached_network_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dev_center_name }}',
'{{ attached_network_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: attached_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the attached_networks resource.
  - name: dev_center_name
    value: "{{ dev_center_name }}"
    description: Required parameter for the attached_networks resource.
  - name: attached_network_connection_name
    value: "{{ attached_network_connection_name }}"
    description: Required parameter for the attached_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the attached_networks resource.
  - name: properties
    value:
      networkConnectionId: "{{ networkConnectionId }}"

REPLACE examples

create_or_update

Creates or updates an attached NetworkConnection.

REPLACE azure.devcenter.attached_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND attached_network_connection_name = '{{ attached_network_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Un-attach a NetworkConnection.

DELETE FROM azure.devcenter.attached_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND attached_network_connection_name = '{{ attached_network_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;