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

OK - Returns the connection.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The scope connection properties
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

OK - Returns information about the network manager connection(s).

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The scope connection properties
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			Get a specified connection created by this management group.
list	select	managementGroupId	$top, $skipToken	List all network manager connections created by this management group.
create_or_update	insert			Create a network manager connection on this management group.
delete	delete			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
managementGroupId	string	The management group Id which uniquely identify the Microsoft Azure management group.
$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.
$top	integer (int32)	An optional query parameter which specifies the maximum number of records to be returned by the server.

SELECT examples

get

Get a specified connection created by this management group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.management_group_network_manager_connections
;

list

List all network manager connections created by this management group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.management_group_network_manager_connections
WHERE managementGroupId = '{{ managementGroupId }}' -- 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 (
data__properties
)
SELECT 
'{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: management_group_network_manager_connections
  props:
    - name: properties
      value: object
      description: |
        The scope connection properties

DELETE examples

delete

Delete specified pending connection created by this management group.

DELETE FROM azure.network.management_group_network_manager_connections
;