network_connections

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

Overview

Name	network_connections
Type	Resource
Id	azure.dev_center.network_connections

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a Network Connection
tags	object	Resource tags.

list_by_resource_group

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a Network Connection
tags	object	Resource tags.

list_by_subscription

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a Network Connection
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a network connection resource
list_by_resource_group	select			Lists network connections in a resource group
list_by_subscription	select			Lists network connections in a subscription
create_or_update	insert			Creates or updates a Network Connections resource
update	update			Partially updates a Network Connection
delete	delete			Deletes a Network Connections resource
run_health_checks	exec	subscriptionId, resourceGroupName, networkConnectionName		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
networkConnectionName	string	Name of the Network Connection that can be applied to a Pool.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a network connection resource

SELECT
location,
properties,
tags
FROM azure.dev_center.network_connections
;

list_by_resource_group

Lists network connections in a resource group

SELECT
location,
properties,
tags
FROM azure.dev_center.network_connections
;

list_by_subscription

Lists network connections in a subscription

SELECT
location,
properties,
tags
FROM azure.dev_center.network_connections
;

INSERT examples

create_or_update

Creates or updates a Network Connections resource

INSERT INTO azure.dev_center.network_connections (
data__tags,
data__location,
data__properties
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_connections
  props:
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of a Network Connection

UPDATE examples

update

Partially updates a Network Connection

UPDATE azure.dev_center.network_connections
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a Network Connections resource

DELETE FROM azure.dev_center.network_connections
;

Lifecycle Methods

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.dev_center.network_connections.run_health_checks 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkConnectionName='{{ networkConnectionName }}' --required
;