network_to_network_interconnects

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

Overview

Name	network_to_network_interconnects
Type	Resource
Id	azure.managed_network_fabric.network_to_network_interconnects

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Resource properties.

list_by_network_fabric

Lists all Network To Network Interconnects under the resource group.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, networkFabricName, networkToNetworkInterconnectName		Implements NetworkToNetworkInterconnects GET method.
list_by_network_fabric	select	subscriptionId, resourceGroupName, networkFabricName		Implements Network To Network Interconnects list by Network Fabric GET method.
create	insert	subscriptionId, resourceGroupName, networkFabricName, networkToNetworkInterconnectName, data__properties		Configuration used to setup CE-PE connectivity PUT Method.
update	update	subscriptionId, resourceGroupName, networkFabricName, networkToNetworkInterconnectName		Update certain properties of the Network To NetworkInterconnects resource.
delete	delete	subscriptionId, resourceGroupName, networkFabricName, networkToNetworkInterconnectName		Implements NetworkToNetworkInterconnects DELETE method.
update_npb_static_route_bfd_administrative_state	exec	subscriptionId, resourceGroupName, networkFabricName, networkToNetworkInterconnectName		Updates the NPB Static Route BFD Administrative State.
update_administrative_state	exec	subscriptionId, resourceGroupName, networkFabricName, networkToNetworkInterconnectName		Updates the Admin State.

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
networkFabricName	string	Name of the Network Fabric.
networkToNetworkInterconnectName	string	Name of the Network to Network Interconnect.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Implements NetworkToNetworkInterconnects GET method.

SELECT
properties
FROM azure.managed_network_fabric.network_to_network_interconnects
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkFabricName = '{{ networkFabricName }}' -- required
AND networkToNetworkInterconnectName = '{{ networkToNetworkInterconnectName }}' -- required
;

list_by_network_fabric

Implements Network To Network Interconnects list by Network Fabric GET method.

SELECT
properties
FROM azure.managed_network_fabric.network_to_network_interconnects
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkFabricName = '{{ networkFabricName }}' -- required
;

INSERT examples

create

Configuration used to setup CE-PE connectivity PUT Method.

INSERT INTO azure.managed_network_fabric.network_to_network_interconnects (
data__properties,
subscriptionId,
resourceGroupName,
networkFabricName,
networkToNetworkInterconnectName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkFabricName }}',
'{{ networkToNetworkInterconnectName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: network_to_network_interconnects
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the network_to_network_interconnects resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_to_network_interconnects resource.
    - name: networkFabricName
      value: string
      description: Required parameter for the network_to_network_interconnects resource.
    - name: networkToNetworkInterconnectName
      value: string
      description: Required parameter for the network_to_network_interconnects resource.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Update certain properties of the Network To NetworkInterconnects resource.

UPDATE azure.managed_network_fabric.network_to_network_interconnects
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkFabricName = '{{ networkFabricName }}' --required
AND networkToNetworkInterconnectName = '{{ networkToNetworkInterconnectName }}' --required
RETURNING
properties;

DELETE examples

delete

Implements NetworkToNetworkInterconnects DELETE method.

DELETE FROM azure.managed_network_fabric.network_to_network_interconnects
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkFabricName = '{{ networkFabricName }}' --required
AND networkToNetworkInterconnectName = '{{ networkToNetworkInterconnectName }}' --required
;

Lifecycle Methods

update_npb_static_route_bfd_administrative_state

Updates the NPB Static Route BFD Administrative State.

EXEC azure.managed_network_fabric.network_to_network_interconnects.update_npb_static_route_bfd_administrative_state 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required, 
@networkToNetworkInterconnectName='{{ networkToNetworkInterconnectName }}' --required 
@@json=
'{
"state": "{{ state }}", 
"resourceIds": "{{ resourceIds }}"
}'
;

update_administrative_state

Updates the Admin State.

EXEC azure.managed_network_fabric.network_to_network_interconnects.update_administrative_state 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required, 
@networkToNetworkInterconnectName='{{ networkToNetworkInterconnectName }}' --required 
@@json=
'{
"state": "{{ state }}", 
"resourceIds": "{{ resourceIds }}"
}'
;