subscription_network_manager_connections

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

Overview

Name	subscription_network_manager_connections
Type	Resource
Id	azure.network.subscription_network_manager_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
connectionState	string	Connection state. Known values are: "Connected", "Pending", "Conflict", "Revoked", and "Rejected". (Connected, Pending, Conflict, Revoked, Rejected)
description	string	A description of the network manager connection.
etag	string	A unique read-only string that changes whenever the resource is updated.
networkManagerId	string	Network Manager Id.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
connectionState	string	Connection state. Known values are: "Connected", "Pending", "Conflict", "Revoked", and "Rejected". (Connected, Pending, Conflict, Revoked, Rejected)
description	string	A description of the network manager connection.
etag	string	A unique read-only string that changes whenever the resource is updated.
networkManagerId	string	Network Manager Id.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	network_manager_connection_name, subscription_id		Get a specified connection created by this subscription.
list	select	subscription_id	$top, $skipToken	List all network manager connections created by this subscription.
create_or_update	insert	network_manager_connection_name, subscription_id		Create a network manager connection on this subscription.
create_or_update	replace	network_manager_connection_name, subscription_id		Create a network manager connection on this subscription.
delete	delete	network_manager_connection_name, subscription_id		Delete specified connection created by this subscription.

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_manager_connection_name	string	Name for the network manager connection. Required.
subscription_id	string
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.

SELECT examples

get

Get a specified connection created by this subscription.

SELECT
id,
name,
connectionState,
description,
etag,
networkManagerId,
systemData,
type
FROM azure.network.subscription_network_manager_connections
WHERE network_manager_connection_name = '{{ network_manager_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all network manager connections created by this subscription.

SELECT
id,
name,
connectionState,
description,
etag,
networkManagerId,
systemData,
type
FROM azure.network.subscription_network_manager_connections
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a network manager connection on this subscription.

INSERT INTO azure.network.subscription_network_manager_connections (
properties,
network_manager_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ network_manager_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: subscription_network_manager_connections
props:
  - name: network_manager_connection_name
    value: "{{ network_manager_connection_name }}"
    description: Required parameter for the subscription_network_manager_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the subscription_network_manager_connections resource.
  - name: properties
    description: |
      The scope connection properties.
    value:
      networkManagerId: "{{ networkManagerId }}"
      connectionState: "{{ connectionState }}"
      description: "{{ description }}"

REPLACE examples

create_or_update

Create a network manager connection on this subscription.

REPLACE azure.network.subscription_network_manager_connections
SET 
properties = '{{ properties }}'
WHERE 
network_manager_connection_name = '{{ network_manager_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Delete specified connection created by this subscription.

DELETE FROM azure.network.subscription_network_manager_connections
WHERE network_manager_connection_name = '{{ network_manager_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;