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_extras.managed_network_fabric.network_to_network_interconnects

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
conditionalDefaultRouteConfiguration	object	Conditional Default Route Configuration properties.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
egressAclId	string	Egress Acl. ARM resource ID of Access Control Lists.
exportRoutePolicy	object	Export Route Policy information.
importRoutePolicy	object	Import Route Policy information.
ingressAclId	string	Ingress Acl. ARM resource ID of Access Control Lists.
isManagementType	string	Configuration to use NNI for Infrastructure Management. Example: True/False. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
layer2Configuration	object	Common properties for Layer2 Configuration.
microBfdState	string	Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
nniType	string	Type of NNI used. Example: CE | NPB. Known values are: "CE" and "NPB". (CE, NPB)
npbStaticRouteConfiguration	object	NPB Static Route Configuration properties.
optionBLayer3Configuration	object	Common properties for Layer3Configuration.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
staticRouteConfiguration	object	Static Route Configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useOptionB	string	Based on this option layer3 parameters are mandatory. Example: True/False. Required. Known values are: "True" and "False". (True, False)

list_by_network_fabric

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
conditionalDefaultRouteConfiguration	object	Conditional Default Route Configuration properties.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
egressAclId	string	Egress Acl. ARM resource ID of Access Control Lists.
exportRoutePolicy	object	Export Route Policy information.
importRoutePolicy	object	Import Route Policy information.
ingressAclId	string	Ingress Acl. ARM resource ID of Access Control Lists.
isManagementType	string	Configuration to use NNI for Infrastructure Management. Example: True/False. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
layer2Configuration	object	Common properties for Layer2 Configuration.
microBfdState	string	Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
nniType	string	Type of NNI used. Example: CE | NPB. Known values are: "CE" and "NPB". (CE, NPB)
npbStaticRouteConfiguration	object	NPB Static Route Configuration properties.
optionBLayer3Configuration	object	Common properties for Layer3Configuration.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
staticRouteConfiguration	object	Static Route Configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useOptionB	string	Based on this option layer3 parameters are mandatory. Example: True/False. Required. Known values are: "True" and "False". (True, False)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id		Implements NetworkToNetworkInterconnects GET method.
list_by_network_fabric	select	resource_group_name, network_fabric_name, subscription_id		Implements Network To Network Interconnects list by Network Fabric GET method.
create	insert	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id, properties		Configuration used to setup CE-PE connectivity PUT Method.
update	update	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id		Update certain properties of the Network To NetworkInterconnects resource.
delete	delete	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id		Implements NetworkToNetworkInterconnects DELETE method.
update_npb_static_route_bfd_administrative_state	exec	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id		Updates the NPB Static Route BFD Administrative State.
update_administrative_state	exec	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id		Updates the Admin State.
update_bfd_administrative_state	exec	resource_group_name, network_fabric_name, network_to_network_interconnect_name, subscription_id		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
network_fabric_name	string	Name of the Network Fabric. Required.
network_to_network_interconnect_name	string	Name of the Network to Network Interconnect. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Implements NetworkToNetworkInterconnects GET method.

SELECT
id,
name,
administrativeState,
conditionalDefaultRouteConfiguration,
configurationState,
egressAclId,
exportRoutePolicy,
importRoutePolicy,
ingressAclId,
isManagementType,
lastOperation,
layer2Configuration,
microBfdState,
nniType,
npbStaticRouteConfiguration,
optionBLayer3Configuration,
provisioningState,
staticRouteConfiguration,
systemData,
type,
useOptionB
FROM azure_extras.managed_network_fabric.network_to_network_interconnects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_fabric_name = '{{ network_fabric_name }}' -- required
AND network_to_network_interconnect_name = '{{ network_to_network_interconnect_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_network_fabric

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

SELECT
id,
name,
administrativeState,
conditionalDefaultRouteConfiguration,
configurationState,
egressAclId,
exportRoutePolicy,
importRoutePolicy,
ingressAclId,
isManagementType,
lastOperation,
layer2Configuration,
microBfdState,
nniType,
npbStaticRouteConfiguration,
optionBLayer3Configuration,
provisioningState,
staticRouteConfiguration,
systemData,
type,
useOptionB
FROM azure_extras.managed_network_fabric.network_to_network_interconnects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_fabric_name = '{{ network_fabric_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Configuration used to setup CE-PE connectivity PUT Method.

INSERT INTO azure_extras.managed_network_fabric.network_to_network_interconnects (
properties,
resource_group_name,
network_fabric_name,
network_to_network_interconnect_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ network_fabric_name }}',
'{{ network_to_network_interconnect_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_to_network_interconnects
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_to_network_interconnects resource.
  - name: network_fabric_name
    value: "{{ network_fabric_name }}"
    description: Required parameter for the network_to_network_interconnects resource.
  - name: network_to_network_interconnect_name
    value: "{{ network_to_network_interconnect_name }}"
    description: Required parameter for the network_to_network_interconnects resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_to_network_interconnects resource.
  - name: properties
    description: |
      The NetworkToNetworkInterconnect Properties. Required.
    value:
      nniType: "{{ nniType }}"
      isManagementType: "{{ isManagementType }}"
      useOptionB: "{{ useOptionB }}"
      layer2Configuration:
        mtu: {{ mtu }}
        interfaces:
          - "{{ interfaces }}"
      optionBLayer3Configuration:
        primaryIpv4Prefix: "{{ primaryIpv4Prefix }}"
        primaryIpv6Prefix: "{{ primaryIpv6Prefix }}"
        secondaryIpv4Prefix: "{{ secondaryIpv4Prefix }}"
        secondaryIpv6Prefix: "{{ secondaryIpv6Prefix }}"
        peerASN: {{ peerASN }}
        vlanId: {{ vlanId }}
        fabricASN: {{ fabricASN }}
        peLoopbackIpAddress:
          - "{{ peLoopbackIpAddress }}"
        bmpConfiguration:
          configurationState: "{{ configurationState }}"
        prefixLimits:
          - maximumRoutes: {{ maximumRoutes }}
      npbStaticRouteConfiguration:
        bfdConfiguration:
          administrativeState: "{{ administrativeState }}"
          intervalInMilliSeconds: {{ intervalInMilliSeconds }}
          multiplier: {{ multiplier }}
        ipv4Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
        ipv6Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
      staticRouteConfiguration:
        bfdConfiguration:
          administrativeState: "{{ administrativeState }}"
          intervalInMilliSeconds: {{ intervalInMilliSeconds }}
          multiplier: {{ multiplier }}
        ipv4Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
        ipv6Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
      importRoutePolicy:
        importIpv4RoutePolicyId: "{{ importIpv4RoutePolicyId }}"
        importIpv6RoutePolicyId: "{{ importIpv6RoutePolicyId }}"
      exportRoutePolicy:
        exportIpv4RoutePolicyId: "{{ exportIpv4RoutePolicyId }}"
        exportIpv6RoutePolicyId: "{{ exportIpv6RoutePolicyId }}"
      egressAclId: "{{ egressAclId }}"
      ingressAclId: "{{ ingressAclId }}"
      microBfdState: "{{ microBfdState }}"
      conditionalDefaultRouteConfiguration:
        ipv4Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
        ipv6Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
      lastOperation:
        details: "{{ details }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

Update certain properties of the Network To NetworkInterconnects resource.

UPDATE azure_extras.managed_network_fabric.network_to_network_interconnects
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_fabric_name = '{{ network_fabric_name }}' --required
AND network_to_network_interconnect_name = '{{ network_to_network_interconnect_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Implements NetworkToNetworkInterconnects DELETE method.

DELETE FROM azure_extras.managed_network_fabric.network_to_network_interconnects
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_fabric_name = '{{ network_fabric_name }}' --required
AND network_to_network_interconnect_name = '{{ network_to_network_interconnect_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_npb_static_route_bfd_administrative_state

Updates the NPB Static Route BFD Administrative State.

EXEC azure_extras.managed_network_fabric.network_to_network_interconnects.update_npb_static_route_bfd_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@network_to_network_interconnect_name='{{ network_to_network_interconnect_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

update_administrative_state

Updates the Admin State.

EXEC azure_extras.managed_network_fabric.network_to_network_interconnects.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@network_to_network_interconnect_name='{{ network_to_network_interconnect_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

update_bfd_administrative_state

Updates the Admin State.

EXEC azure_extras.managed_network_fabric.network_to_network_interconnects.update_bfd_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@network_to_network_interconnect_name='{{ network_to_network_interconnect_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"routeType": "{{ routeType }}", 
"administrativeState": "{{ administrativeState }}"
}'
;