scope_connections

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

Overview

Name	scope_connections
Type	Resource
Id	azure.network.scope_connections

Fields

The following fields are returned by SELECT queries:

get

OK - Returns the resource

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 scope 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 specified scope connection created by this Network Manager.
list	select	subscriptionId, resourceGroupName, networkManagerName	$top, $skipToken	List all scope connections created by this network manager.
create_or_update	insert			Creates or updates scope connection from Network Manager
delete	delete			Delete the pending scope connection created by this network manager.

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
networkManagerName	string	The name of the network manager.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$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 specified scope connection created by this Network Manager.

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

list

List all scope connections created by this network manager.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.scope_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkManagerName = '{{ networkManagerName }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates scope connection from Network Manager

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

Manifest

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

DELETE examples

delete

Delete the pending scope connection created by this network manager.

DELETE FROM azure.network.scope_connections
;