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

Get successful. The operation returns the specified Managed Network Connectivity Configuration 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	Properties of a network manager connectivity configuration
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Get successful. The operation returns all network manager connectivity configuration resources in the specified network manager, in a paginated format

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	Properties of a network manager connectivity configuration
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			Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name
list	select	subscriptionId, resourceGroupName, networkManagerName	$top, $skipToken	Lists all the network manager connectivity configuration in a specified network manager.
create_or_update	insert			Creates/Updates a new network manager connectivity configuration
delete	delete		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
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.
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.

SELECT examples

get

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

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

list

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

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.connectivity_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkManagerName = '{{ networkManagerName }}' -- 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 (
data__properties
)
SELECT 
'{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connectivity_configurations
  props:
    - name: properties
      value: object
      description: |
        Properties of a network manager connectivity configuration

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 force = '{{ force }}'
;