external_networks

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

Overview

Name	external_networks
Type	Resource
Id	azure_extras.managed_network_fabric.external_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.
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)
exportRoutePolicy	object	Export Route Policy either IPv4 or IPv6.
importRoutePolicy	object	Import Route Policy either IPv4 or IPv6.
lastOperation	object	Details of the last operation performed on the resource.
networkFabricId	string	Associated Network Fabric Resource ID.
networkToNetworkInterconnectId	string	ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.
optionAProperties	object	option A properties object.
optionBProperties	object	option B properties object.
peeringOption	string	Peering option list. Required. Known values are: "OptionA" and "OptionB". (OptionA, OptionB)
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".

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.
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)
exportRoutePolicy	object	Export Route Policy either IPv4 or IPv6.
importRoutePolicy	object	Import Route Policy either IPv4 or IPv6.
lastOperation	object	Details of the last operation performed on the resource.
networkFabricId	string	Associated Network Fabric Resource ID.
networkToNetworkInterconnectId	string	ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.
optionAProperties	object	option A properties object.
optionBProperties	object	option B properties object.
peeringOption	string	Peering option list. Required. Known values are: "OptionA" and "OptionB". (OptionA, OptionB)
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".

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, external_network_name, subscription_id		Implements ExternalNetworks GET method.
list_by_l3_isolation_domain	select	resource_group_name, l3_isolation_domain_name, subscription_id		Implements External Networks list by resource group GET method.
create	insert	resource_group_name, l3_isolation_domain_name, external_network_name, subscription_id, properties		Creates ExternalNetwork PUT method.
update	update	resource_group_name, l3_isolation_domain_name, external_network_name, subscription_id		API to update certain properties of the ExternalNetworks resource.
delete	delete	resource_group_name, l3_isolation_domain_name, external_network_name, subscription_id		Implements ExternalNetworks DELETE method.
update_administrative_state	exec	resource_group_name, l3_isolation_domain_name, external_network_name, subscription_id		Executes update operation to enable or disable administrative State for externalNetwork.
update_static_route_bfd_administrative_state	exec	resource_group_name, l3_isolation_domain_name, external_network_name, subscription_id		Update Static Route BFD for external Network.
update_bfd_administrative_state	exec	resource_group_name, l3_isolation_domain_name, external_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
external_network_name	string	Name of the External 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

Implements ExternalNetworks GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
exportRoutePolicy,
importRoutePolicy,
lastOperation,
networkFabricId,
networkToNetworkInterconnectId,
optionAProperties,
optionBProperties,
peeringOption,
provisioningState,
staticRouteConfiguration,
systemData,
type
FROM azure_extras.managed_network_fabric.external_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND l3_isolation_domain_name = '{{ l3_isolation_domain_name }}' -- required
AND external_network_name = '{{ external_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_l3_isolation_domain

Implements External Networks list by resource group GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
exportRoutePolicy,
importRoutePolicy,
lastOperation,
networkFabricId,
networkToNetworkInterconnectId,
optionAProperties,
optionBProperties,
peeringOption,
provisioningState,
staticRouteConfiguration,
systemData,
type
FROM azure_extras.managed_network_fabric.external_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 ExternalNetwork PUT method.

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

Manifest

# Description fields are for documentation purposes
- name: external_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the external_networks resource.
  - name: l3_isolation_domain_name
    value: "{{ l3_isolation_domain_name }}"
    description: Required parameter for the external_networks resource.
  - name: external_network_name
    value: "{{ external_network_name }}"
    description: Required parameter for the external_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the external_networks resource.
  - name: properties
    description: |
      External Network Properties. Required.
    value:
      annotation: "{{ annotation }}"
      networkToNetworkInterconnectId: "{{ networkToNetworkInterconnectId }}"
      importRoutePolicy:
        importIpv4RoutePolicyId: "{{ importIpv4RoutePolicyId }}"
        importIpv6RoutePolicyId: "{{ importIpv6RoutePolicyId }}"
      exportRoutePolicy:
        exportIpv4RoutePolicyId: "{{ exportIpv4RoutePolicyId }}"
        exportIpv6RoutePolicyId: "{{ exportIpv6RoutePolicyId }}"
      peeringOption: "{{ peeringOption }}"
      optionBProperties:
        importRouteTargets:
          - "{{ importRouteTargets }}"
        exportRouteTargets:
          - "{{ exportRouteTargets }}"
        routeTargets:
          importIpv4RouteTargets:
            - "{{ importIpv4RouteTargets }}"
          importIpv6RouteTargets:
            - "{{ importIpv6RouteTargets }}"
          exportIpv4RouteTargets:
            - "{{ exportIpv4RouteTargets }}"
          exportIpv6RouteTargets:
            - "{{ exportIpv6RouteTargets }}"
      optionAProperties:
        primaryIpv4Prefix: "{{ primaryIpv4Prefix }}"
        primaryIpv6Prefix: "{{ primaryIpv6Prefix }}"
        secondaryIpv4Prefix: "{{ secondaryIpv4Prefix }}"
        secondaryIpv6Prefix: "{{ secondaryIpv6Prefix }}"
        mtu: {{ mtu }}
        vlanId: {{ vlanId }}
        fabricASN: {{ fabricASN }}
        peerASN: {{ peerASN }}
        bfdConfiguration:
          administrativeState: "{{ administrativeState }}"
          intervalInMilliSeconds: {{ intervalInMilliSeconds }}
          multiplier: {{ multiplier }}
        ingressAclId: "{{ ingressAclId }}"
        bmpConfiguration:
          configurationState: "{{ configurationState }}"
        egressAclId: "{{ egressAclId }}"
        v4OverV6BgpSession: "{{ v4OverV6BgpSession }}"
        v6OverV4BgpSession: "{{ v6OverV4BgpSession }}"
        nativeIpv4PrefixLimit:
          prefixLimits:
            - maximumRoutes: {{ maximumRoutes }}
              threshold: {{ threshold }}
              idleTimeExpiry: {{ idleTimeExpiry }}
        nativeIpv6PrefixLimit:
          prefixLimits:
            - maximumRoutes: {{ maximumRoutes }}
              threshold: {{ threshold }}
              idleTimeExpiry: {{ idleTimeExpiry }}
      staticRouteConfiguration:
        bfdConfiguration:
          administrativeState: "{{ administrativeState }}"
          intervalInMilliSeconds: {{ intervalInMilliSeconds }}
          multiplier: {{ multiplier }}
        ipv4Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
        ipv6Routes:
          - prefix: "{{ prefix }}"
            nextHop: "{{ nextHop }}"
      lastOperation:
        details: "{{ details }}"
      networkFabricId: "{{ networkFabricId }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

API to update certain properties of the ExternalNetworks resource.

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

DELETE examples

delete

Implements ExternalNetworks DELETE method.

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

Lifecycle Methods

update_administrative_state

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

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

update_static_route_bfd_administrative_state

Update Static Route BFD for external Network.

EXEC azure_extras.managed_network_fabric.external_networks.update_static_route_bfd_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@external_network_name='{{ external_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.external_networks.update_bfd_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@external_network_name='{{ external_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"routeType": "{{ routeType }}", 
"administrativeState": "{{ administrativeState }}"
}'
;