internal_networks

Creates, updates, deletes, gets or lists an internal_networks resource.

Overview

Name	internal_networks
Type	Resource
Id	azure_extras.managed_network_fabric.internal_networks

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)
annotation	string	Switch configuration description.
bgpConfiguration	object	BGP 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)
connectedIPv4Subnets	array	List of Connected IPv4 Subnets.
connectedIPv6Subnets	array	List of connected IPv6 Subnets.
egressAclId	string	Egress Acl. ARM resource ID of Access Control Lists.
exportRoutePolicy	object	Export Route Policy either IPv4 or IPv6.
extension	string	Extension. Example: NoExtension | NPB. Known values are: "NoExtension" and "NPB". (NoExtension, NPB)
importRoutePolicy	object	Import Route Policy either IPv4 or IPv6.
ingressAclId	string	Ingress Acl. ARM resource ID of Access Control Lists.
isMonitoringEnabled	string	To check whether monitoring of internal network is enabled or not. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
mtu	integer	Maximum transmission unit. Default value is 1500.
nativeIpv4PrefixLimit	object	Native IPv4 Prefix Limit Configuration properties.
nativeIpv6PrefixLimit	object	Native IPv6 Prefix Limit Configuration properties.
networkFabricId	string	Associated Network Fabric Resource ID.
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 properties.
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".
vlanId	integer	Vlan identifier. Example: 1001. Required.

list_by_l3_isolation_domain

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)
annotation	string	Switch configuration description.
bgpConfiguration	object	BGP 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)
connectedIPv4Subnets	array	List of Connected IPv4 Subnets.
connectedIPv6Subnets	array	List of connected IPv6 Subnets.
egressAclId	string	Egress Acl. ARM resource ID of Access Control Lists.
exportRoutePolicy	object	Export Route Policy either IPv4 or IPv6.
extension	string	Extension. Example: NoExtension | NPB. Known values are: "NoExtension" and "NPB". (NoExtension, NPB)
importRoutePolicy	object	Import Route Policy either IPv4 or IPv6.
ingressAclId	string	Ingress Acl. ARM resource ID of Access Control Lists.
isMonitoringEnabled	string	To check whether monitoring of internal network is enabled or not. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
mtu	integer	Maximum transmission unit. Default value is 1500.
nativeIpv4PrefixLimit	object	Native IPv4 Prefix Limit Configuration properties.
nativeIpv6PrefixLimit	object	Native IPv6 Prefix Limit Configuration properties.
networkFabricId	string	Associated Network Fabric Resource ID.
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 properties.
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".
vlanId	integer	Vlan identifier. Example: 1001. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		Gets a InternalNetworks.
list_by_l3_isolation_domain	select	resource_group_name, l3_isolation_domain_name, subscription_id		Displays InternalNetworks list by resource group GET method.
create	insert	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id, properties		Creates InternalNetwork PUT method.
update	update	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		Updates a InternalNetworks.
delete	delete	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		Implements InternalNetworks DELETE method.
update_administrative_state	exec	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		Executes update operation to enable or disable administrative State for InternalNetwork.
update_bgp_administrative_state	exec	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		Update BGP state for internalNetwork. Allowed only on edge devices.
update_static_route_bfd_administrative_state	exec	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		Update Static Route BFD administrative state for internalNetwork.
update_bfd_administrative_state	exec	resource_group_name, l3_isolation_domain_name, internal_network_name, subscription_id		BFD administrative state for either static or bgp for internalNetwork.

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
internal_network_name	string	Name of the Internal Network. Required.
l3_isolation_domain_name	string	Name of the L3 Isolation Domain. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a InternalNetworks.

SELECT
id,
name,
administrativeState,
annotation,
bgpConfiguration,
configurationState,
connectedIPv4Subnets,
connectedIPv6Subnets,
egressAclId,
exportRoutePolicy,
extension,
importRoutePolicy,
ingressAclId,
isMonitoringEnabled,
lastOperation,
mtu,
nativeIpv4PrefixLimit,
nativeIpv6PrefixLimit,
networkFabricId,
provisioningState,
staticRouteConfiguration,
systemData,
type,
vlanId
FROM azure_extras.managed_network_fabric.internal_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND l3_isolation_domain_name = '{{ l3_isolation_domain_name }}' -- required
AND internal_network_name = '{{ internal_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_l3_isolation_domain

Displays InternalNetworks list by resource group GET method.

SELECT
id,
name,
administrativeState,
annotation,
bgpConfiguration,
configurationState,
connectedIPv4Subnets,
connectedIPv6Subnets,
egressAclId,
exportRoutePolicy,
extension,
importRoutePolicy,
ingressAclId,
isMonitoringEnabled,
lastOperation,
mtu,
nativeIpv4PrefixLimit,
nativeIpv6PrefixLimit,
networkFabricId,
provisioningState,
staticRouteConfiguration,
systemData,
type,
vlanId
FROM azure_extras.managed_network_fabric.internal_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND l3_isolation_domain_name = '{{ l3_isolation_domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates InternalNetwork PUT method.

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

Manifest

# Description fields are for documentation purposes
- name: internal_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the internal_networks resource.
  - name: l3_isolation_domain_name
    value: "{{ l3_isolation_domain_name }}"
    description: Required parameter for the internal_networks resource.
  - name: internal_network_name
    value: "{{ internal_network_name }}"
    description: Required parameter for the internal_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the internal_networks resource.
  - name: properties
    description: |
      The Internal Network Properties. Required.
    value:
      annotation: "{{ annotation }}"
      extension: "{{ extension }}"
      mtu: {{ mtu }}
      connectedIPv4Subnets:
        - annotation: "{{ annotation }}"
          prefix: "{{ prefix }}"
      connectedIPv6Subnets:
        - annotation: "{{ annotation }}"
          prefix: "{{ prefix }}"
      importRoutePolicy:
        importIpv4RoutePolicyId: "{{ importIpv4RoutePolicyId }}"
        importIpv6RoutePolicyId: "{{ importIpv6RoutePolicyId }}"
      exportRoutePolicy:
        exportIpv4RoutePolicyId: "{{ exportIpv4RoutePolicyId }}"
        exportIpv6RoutePolicyId: "{{ exportIpv6RoutePolicyId }}"
      ingressAclId: "{{ ingressAclId }}"
      egressAclId: "{{ egressAclId }}"
      isMonitoringEnabled: "{{ isMonitoringEnabled }}"
      vlanId: {{ vlanId }}
      bgpConfiguration:
        annotation: "{{ annotation }}"
        bfdConfiguration:
          administrativeState: "{{ administrativeState }}"
          intervalInMilliSeconds: {{ intervalInMilliSeconds }}
          multiplier: {{ multiplier }}
        defaultRouteOriginate: "{{ defaultRouteOriginate }}"
        allowAS: {{ allowAS }}
        allowASOverride: "{{ allowASOverride }}"
        fabricASN: {{ fabricASN }}
        peerASN: {{ peerASN }}
        ipv4ListenRangePrefixes:
          - "{{ ipv4ListenRangePrefixes }}"
        ipv6ListenRangePrefixes:
          - "{{ ipv6ListenRangePrefixes }}"
        ipv4NeighborAddress:
          - address: "{{ address }}"
            bfdAdministrativeState: "{{ bfdAdministrativeState }}"
            bgpAdministrativeState: "{{ bgpAdministrativeState }}"
            configurationState: "{{ configurationState }}"
        ipv6NeighborAddress:
          - address: "{{ address }}"
            bfdAdministrativeState: "{{ bfdAdministrativeState }}"
            bgpAdministrativeState: "{{ bgpAdministrativeState }}"
            configurationState: "{{ configurationState }}"
        bmpConfiguration:
          neighborIpExclusions:
            - "{{ neighborIpExclusions }}"
          bmpConfigurationState: "{{ bmpConfigurationState }}"
          exportPolicyConfiguration:
            exportPolicies:
              - "{{ exportPolicies }}"
        v4OverV6BgpSession: "{{ v4OverV6BgpSession }}"
        v6OverV4BgpSession: "{{ v6OverV4BgpSession }}"
      staticRouteConfiguration:
        bfdConfiguration:
          administrativeState: "{{ administrativeState }}"
          intervalInMilliSeconds: {{ intervalInMilliSeconds }}
          multiplier: {{ multiplier }}
        ipv4Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
        ipv6Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
        extension: "{{ extension }}"
      nativeIpv4PrefixLimit:
        prefixLimits:
          - maximumRoutes: {{ maximumRoutes }}
            threshold: {{ threshold }}
            idleTimeExpiry: {{ idleTimeExpiry }}
      nativeIpv6PrefixLimit:
        prefixLimits:
          - maximumRoutes: {{ maximumRoutes }}
            threshold: {{ threshold }}
            idleTimeExpiry: {{ idleTimeExpiry }}
      lastOperation:
        details: "{{ details }}"
      networkFabricId: "{{ networkFabricId }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

Updates a InternalNetworks.

UPDATE azure_extras.managed_network_fabric.internal_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND l3_isolation_domain_name = '{{ l3_isolation_domain_name }}' --required
AND internal_network_name = '{{ internal_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Implements InternalNetworks DELETE method.

DELETE FROM azure_extras.managed_network_fabric.internal_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND l3_isolation_domain_name = '{{ l3_isolation_domain_name }}' --required
AND internal_network_name = '{{ internal_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_administrative_state

Executes update operation to enable or disable administrative State for InternalNetwork.

EXEC azure_extras.managed_network_fabric.internal_networks.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@internal_network_name='{{ internal_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

update_bgp_administrative_state

Update BGP state for internalNetwork. Allowed only on edge devices.

EXEC azure_extras.managed_network_fabric.internal_networks.update_bgp_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@internal_network_name='{{ internal_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"neighborAddress": "{{ neighborAddress }}", 
"administrativeState": "{{ administrativeState }}"
}'
;

update_static_route_bfd_administrative_state

Update Static Route BFD administrative state for internalNetwork.

EXEC azure_extras.managed_network_fabric.internal_networks.update_static_route_bfd_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@internal_network_name='{{ internal_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

update_bfd_administrative_state

BFD administrative state for either static or bgp for internalNetwork.

EXEC azure_extras.managed_network_fabric.internal_networks.update_bfd_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@internal_network_name='{{ internal_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"routeType": "{{ routeType }}", 
"neighborAddress": "{{ neighborAddress }}", 
"administrativeState": "{{ administrativeState }}"
}'
;