connectivity_configurations

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

Overview

Name	connectivity_configurations
Type	Resource
Id	azure.network.connectivity_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
appliesToGroups	array	Groups for configuration. Required.
connectivityCapabilities	object	Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource.
connectivityTopology	string	Connectivity topology type. Required. Known values are: "HubAndSpoke" and "Mesh". (HubAndSpoke, Mesh)
deleteExistingPeering	string	Flag if need to remove current existing peerings. Known values are: "False" and "True". (False, True)
description	string	A description of the connectivity configuration.
etag	string	A unique read-only string that changes whenever the resource is updated.
hubs	array	List of hubItems.
isGlobal	string	Flag if global mesh is supported. Known values are: "False" and "True". (False, True)
provisioningState	string	The provisioning state of the connectivity configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
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.
appliesToGroups	array	Groups for configuration. Required.
connectivityCapabilities	object	Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource.
connectivityTopology	string	Connectivity topology type. Required. Known values are: "HubAndSpoke" and "Mesh". (HubAndSpoke, Mesh)
deleteExistingPeering	string	Flag if need to remove current existing peerings. Known values are: "False" and "True". (False, True)
description	string	A description of the connectivity configuration.
etag	string	A unique read-only string that changes whenever the resource is updated.
hubs	array	List of hubItems.
isGlobal	string	Flag if global mesh is supported. Known values are: "False" and "True". (False, True)
provisioningState	string	The provisioning state of the connectivity configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
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	resource_group_name, network_manager_name, configuration_name, subscription_id		Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name.
list	select	resource_group_name, network_manager_name, subscription_id	$top, $skipToken	Lists all the network manager connectivity configuration in a specified network manager.
create_or_update	insert	resource_group_name, network_manager_name, configuration_name, subscription_id		Creates/Updates a new network manager connectivity configuration.
create_or_update	replace	resource_group_name, network_manager_name, configuration_name, subscription_id		Creates/Updates a new network manager connectivity configuration.
delete	delete	resource_group_name, network_manager_name, configuration_name, subscription_id	force	Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name.

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
configuration_name	string	The name of the network manager connectivity configuration. Required.
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.
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.
force	boolean	Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

SELECT examples

get

Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name.

SELECT
id,
name,
appliesToGroups,
connectivityCapabilities,
connectivityTopology,
deleteExistingPeering,
description,
etag,
hubs,
isGlobal,
provisioningState,
resourceGuid,
systemData,
type
FROM azure.network.connectivity_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the network manager connectivity configuration in a specified network manager.

SELECT
id,
name,
appliesToGroups,
connectivityCapabilities,
connectivityTopology,
deleteExistingPeering,
description,
etag,
hubs,
isGlobal,
provisioningState,
resourceGuid,
systemData,
type
FROM azure.network.connectivity_configurations
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/Updates a new network manager connectivity configuration.

INSERT INTO azure.network.connectivity_configurations (
properties,
resource_group_name,
network_manager_name,
configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connectivity_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connectivity_configurations resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the connectivity_configurations resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the connectivity_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connectivity_configurations resource.
  - name: properties
    description: |
      Properties of a network manager connectivity configuration.
    value:
      description: "{{ description }}"
      connectivityTopology: "{{ connectivityTopology }}"
      hubs:
        - resourceId: "{{ resourceId }}"
          resourceType: "{{ resourceType }}"
      isGlobal: "{{ isGlobal }}"
      connectivityCapabilities:
        connectedGroupPrivateEndpointsScale: "{{ connectedGroupPrivateEndpointsScale }}"
        connectedGroupAddressOverlap: "{{ connectedGroupAddressOverlap }}"
        peeringEnforcement: "{{ peeringEnforcement }}"
      appliesToGroups:
        - networkGroupId: "{{ networkGroupId }}"
          useHubGateway: "{{ useHubGateway }}"
          isGlobal: "{{ isGlobal }}"
          groupConnectivity: "{{ groupConnectivity }}"
      provisioningState: "{{ provisioningState }}"
      deleteExistingPeering: "{{ deleteExistingPeering }}"
      resourceGuid: "{{ resourceGuid }}"

REPLACE examples

create_or_update

Creates/Updates a new network manager connectivity configuration.

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

DELETE examples

delete

Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name.

DELETE FROM azure.network.connectivity_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;