network_manager_effective_connectivity_configurations

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

Overview

Name	network_manager_effective_connectivity_configurations
Type	Resource
Id	azure.network.network_manager_effective_connectivity_configurations

Fields

The following fields are returned by SELECT queries:

list_network_manager_effective_connectivity_configurations

Name	Datatype	Description
id	string	Connectivity configuration ID.
appliesToGroups	array	Groups for configuration. Required.
configurationGroups	array	Effective configuration groups.
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.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_network_manager_effective_connectivity_configurations	select	resource_group_name, virtual_network_name, subscription_id	$top	List all effective connectivity configurations applied on a virtual network.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_name	string	The name of the virtual network. Required.
$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

list_network_manager_effective_connectivity_configurations

List all effective connectivity configurations applied on a virtual network.

SELECT
id,
appliesToGroups,
configurationGroups,
connectivityCapabilities,
connectivityTopology,
deleteExistingPeering,
description,
hubs,
isGlobal,
provisioningState,
resourceGuid
FROM azure.network.network_manager_effective_connectivity_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_name = '{{ virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;