management_group_network_manager_connections

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

Overview

Name	management_group_network_manager_connections
Type	Resource
Id	azure.network.management_group_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	management_group_id, network_manager_connection_name		Get a specified connection created by this management group.
list	select	management_group_id	$top, $skipToken	List all network manager connections created by this management group.
create_or_update	insert	management_group_id, network_manager_connection_name		Create a network manager connection on this management group.
create_or_update	replace	management_group_id, network_manager_connection_name		Create a network manager connection on this management group.
delete	delete	management_group_id, network_manager_connection_name		Delete specified pending connection created by this management group.

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
management_group_id	string	The management group ID. Required.
network_manager_connection_name	string	Name for the network manager connection. Required.
$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 management group.

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

list

List all network manager connections created by this management group.

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

INSERT examples

create_or_update

Create a network manager connection on this management group.

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

Manifest

# Description fields are for documentation purposes
- name: management_group_network_manager_connections
props:
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the management_group_network_manager_connections resource.
  - name: network_manager_connection_name
    value: "{{ network_manager_connection_name }}"
    description: Required parameter for the management_group_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 management group.

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

DELETE examples

delete

Delete specified pending connection created by this management group.

DELETE FROM azure.network.management_group_network_manager_connections
WHERE management_group_id = '{{ management_group_id }}' --required
AND network_manager_connection_name = '{{ network_manager_connection_name }}' --required
;