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

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 scope connection.
etag	string	A unique read-only string that changes whenever the resource is updated.
resourceId	string	Resource ID.
systemData	object	The system metadata related to this resource.
tenantId	string	Tenant ID.
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 scope connection.
etag	string	A unique read-only string that changes whenever the resource is updated.
resourceId	string	Resource ID.
systemData	object	The system metadata related to this resource.
tenantId	string	Tenant ID.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_manager_name, scope_connection_name, subscription_id		Get specified scope connection created by this Network Manager.
list	select	resource_group_name, network_manager_name, subscription_id	$top, $skipToken	List all scope connections created by this network manager.
create_or_update	insert	resource_group_name, network_manager_name, scope_connection_name, subscription_id		Creates or updates scope connection from Network Manager.
create_or_update	replace	resource_group_name, network_manager_name, scope_connection_name, subscription_id		Creates or updates scope connection from Network Manager.
delete	delete	resource_group_name, network_manager_name, scope_connection_name, subscription_id		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
network_manager_name	string	The name of the network manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scope_connection_name	string	Name for the cross-tenant 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 specified scope connection created by this Network Manager.

SELECT
id,
name,
connectionState,
description,
etag,
resourceId,
systemData,
tenantId,
type
FROM azure.network.scope_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND scope_connection_name = '{{ scope_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all scope connections created by this network manager.

SELECT
id,
name,
connectionState,
description,
etag,
resourceId,
systemData,
tenantId,
type
FROM azure.network.scope_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
network_manager_name,
scope_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ scope_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: scope_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the scope_connections resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the scope_connections resource.
  - name: scope_connection_name
    value: "{{ scope_connection_name }}"
    description: Required parameter for the scope_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the scope_connections resource.
  - name: properties
    description: |
      The scope connection properties.
    value:
      tenantId: "{{ tenantId }}"
      resourceId: "{{ resourceId }}"
      connectionState: "{{ connectionState }}"
      description: "{{ description }}"

REPLACE examples

create_or_update

Creates or updates scope connection from Network Manager.

REPLACE azure.network.scope_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND scope_connection_name = '{{ scope_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Delete the pending scope connection created by this network manager.

DELETE FROM azure.network.scope_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND scope_connection_name = '{{ scope_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;