express_route_gateways

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

Overview

Name	express_route_gateways
Type	Resource
Id	azure.network.express_route_gateways

Fields

The following fields are returned by SELECT queries:

get_failover_single_test_details

Name	Datatype	Description
endTimeUtc	string	Time when the test was completed.
failoverConnectionDetails	array	List of all the failover connections for this peering location.
nonRedundantRoutes	array	List of al the routes that were received only from this peering location.
peeringLocation	string	Peering location of the test.
redundantRoutes	array	List of routes received from this peering as well as some other peering location.
startTimeUtc	string	Time when the test was started.
status	string	The current status of the test. Known values are: "NotStarted", "Starting", "Running", "StartFailed", "Stopping", "Completed", "StopFailed", "Invalid", and "Expired". (NotStarted, Starting, Running, StartFailed, Stopping, Completed, StopFailed, Invalid, Expired)
wasSimulationSuccessful	boolean	Whether the failover simulation was successful or not.

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowNonVirtualWanTraffic	boolean	Configures this gateway to accept traffic from non Virtual WAN networks.
autoScaleConfiguration	object	Configuration for auto scaling.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteConnections	array	List of ExpressRoute connections to the ExpressRoute gateway.
location	string	Resource location.
provisioningState	string	The provisioning state of the express route gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
virtualHub	object	The Virtual Hub where the ExpressRoute gateway is or will be deployed. Required.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowNonVirtualWanTraffic	boolean	Configures this gateway to accept traffic from non Virtual WAN networks.
autoScaleConfiguration	object	Configuration for auto scaling.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteConnections	array	List of ExpressRoute connections to the ExpressRoute gateway.
location	string	Resource location.
provisioningState	string	The provisioning state of the express route gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
virtualHub	object	The Virtual Hub where the ExpressRoute gateway is or will be deployed. Required.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowNonVirtualWanTraffic	boolean	Configures this gateway to accept traffic from non Virtual WAN networks.
autoScaleConfiguration	object	Configuration for auto scaling.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteConnections	array	List of ExpressRoute connections to the ExpressRoute gateway.
location	string	Resource location.
provisioningState	string	The provisioning state of the express route gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
virtualHub	object	The Virtual Hub where the ExpressRoute gateway is or will be deployed. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_failover_single_test_details	select	resource_group_name, express_route_gateway_name, subscription_id, peeringLocation, failoverTestId		Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.
get	select	resource_group_name, express_route_gateway_name, subscription_id		Fetches the details of a ExpressRoute gateway in a resource group.
list_by_resource_group	select	resource_group_name, subscription_id		Lists ExpressRoute gateways in a given resource group.
list_by_subscription	select	subscription_id		Lists ExpressRoute gateways under a given subscription.
create_or_update	insert	resource_group_name, express_route_gateway_name, subscription_id		Creates or updates a ExpressRoute gateway in a specified resource group.
update_tags	update	resource_group_name, express_route_gateway_name, subscription_id		Updates express route gateway tags.
create_or_update	replace	resource_group_name, express_route_gateway_name, subscription_id		Creates or updates a ExpressRoute gateway in a specified resource group.
delete	delete	resource_group_name, express_route_gateway_name, subscription_id		Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
get_failover_all_tests_details	exec	resource_group_name, express_route_gateway_name, subscription_id	type, fetchLatest	Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.
get_routes_information	exec	resource_group_name, express_route_gateway_name, subscription_id	attemptRefresh	Retrieves the route sets information for the ExpressRoute gateway.
get_resiliency_information	exec	resource_group_name, express_route_gateway_name, subscription_id	attemptRefresh	Retrieves the resiliency information for the ExpressRoute gateway.
start_site_failover_test	exec	resource_group_name, express_route_gateway_name, subscription_id, peeringLocation		Starts failover simulation on the ExpressRoute gateway for the specified peering location.
stop_site_failover_test	exec	resource_group_name, express_route_gateway_name, subscription_id		Stops failover simulation on the ExpressRoute gateway for the specified peering location.

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
express_route_gateway_name	string	The name of the ExpressRoute gateway. Required.
failoverTestId	string	The unique Guid value which identifies the test. Required.
peeringLocation	string	Peering location of the test. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
attemptRefresh	boolean	Whether to attempt a refresh of the resiliency information. Default value is None.
fetchLatest	boolean	Fetch only the latest tests for each peering location. Default value is None.
type	string	The type of failover test. Default value is None.

SELECT examples

get_failover_single_test_details

Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.

SELECT
endTimeUtc,
failoverConnectionDetails,
nonRedundantRoutes,
peeringLocation,
redundantRoutes,
startTimeUtc,
status,
wasSimulationSuccessful
FROM azure.network.express_route_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND peeringLocation = '{{ peeringLocation }}' -- required
AND failoverTestId = '{{ failoverTestId }}' -- required
;

get

Fetches the details of a ExpressRoute gateway in a resource group.

SELECT
id,
name,
allowNonVirtualWanTraffic,
autoScaleConfiguration,
etag,
expressRouteConnections,
location,
provisioningState,
tags,
type,
virtualHub
FROM azure.network.express_route_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists ExpressRoute gateways in a given resource group.

SELECT
id,
name,
allowNonVirtualWanTraffic,
autoScaleConfiguration,
etag,
expressRouteConnections,
location,
provisioningState,
tags,
type,
virtualHub
FROM azure.network.express_route_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists ExpressRoute gateways under a given subscription.

SELECT
id,
name,
allowNonVirtualWanTraffic,
autoScaleConfiguration,
etag,
expressRouteConnections,
location,
provisioningState,
tags,
type,
virtualHub
FROM azure.network.express_route_gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a ExpressRoute gateway in a specified resource group.

INSERT INTO azure.network.express_route_gateways (
id,
location,
tags,
properties,
resource_group_name,
express_route_gateway_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ express_route_gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_gateways resource.
  - name: express_route_gateway_name
    value: "{{ express_route_gateway_name }}"
    description: Required parameter for the express_route_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_gateways resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the express route gateway.
    value:
      autoScaleConfiguration:
        bounds:
          min: {{ min }}
          max: {{ max }}
      expressRouteConnections:
        - id: "{{ id }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            expressRouteCircuitPeering:
              id: "{{ id }}"
            authorizationKey: "{{ authorizationKey }}"
            routingWeight: {{ routingWeight }}
            enableInternetSecurity: {{ enableInternetSecurity }}
            expressRouteGatewayBypass: {{ expressRouteGatewayBypass }}
            enablePrivateLinkFastPath: {{ enablePrivateLinkFastPath }}
            routingConfiguration:
              associatedRouteTable:
                id: "{{ id }}"
              propagatedRouteTables:
                labels: "{{ labels }}"
                ids: "{{ ids }}"
              vnetRoutes:
                staticRoutesConfig: "{{ staticRoutesConfig }}"
                staticRoutes: "{{ staticRoutes }}"
                bgpConnections: "{{ bgpConnections }}"
              inboundRouteMap:
                id: "{{ id }}"
              outboundRouteMap:
                id: "{{ id }}"
          name: "{{ name }}"
      provisioningState: "{{ provisioningState }}"
      virtualHub:
        id: "{{ id }}"
      allowNonVirtualWanTraffic: {{ allowNonVirtualWanTraffic }}

UPDATE examples

update_tags

Updates express route gateway tags.

UPDATE azure.network.express_route_gateways
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a ExpressRoute gateway in a specified resource group.

REPLACE azure.network.express_route_gateways
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

DELETE FROM azure.network.express_route_gateways
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_failover_all_tests_details

Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.

EXEC azure.network.express_route_gateways.get_failover_all_tests_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@express_route_gateway_name='{{ express_route_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@type='{{ type }}', 
@fetchLatest={{ fetchLatest }}
;

get_routes_information

Retrieves the route sets information for the ExpressRoute gateway.

EXEC azure.network.express_route_gateways.get_routes_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@express_route_gateway_name='{{ express_route_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@attemptRefresh={{ attemptRefresh }}
;

get_resiliency_information

Retrieves the resiliency information for the ExpressRoute gateway.

EXEC azure.network.express_route_gateways.get_resiliency_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@express_route_gateway_name='{{ express_route_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@attemptRefresh={{ attemptRefresh }}
;

start_site_failover_test

Starts failover simulation on the ExpressRoute gateway for the specified peering location.

EXEC azure.network.express_route_gateways.start_site_failover_test 
@resource_group_name='{{ resource_group_name }}' --required, 
@express_route_gateway_name='{{ express_route_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@peeringLocation='{{ peeringLocation }}' --required
;

stop_site_failover_test

Stops failover simulation on the ExpressRoute gateway for the specified peering location.

EXEC azure.network.express_route_gateways.stop_site_failover_test 
@resource_group_name='{{ resource_group_name }}' --required, 
@express_route_gateway_name='{{ express_route_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"peeringLocation": "{{ peeringLocation }}", 
"wasSimulationSuccessful": {{ wasSimulationSuccessful }}, 
"details": "{{ details }}"
}'
;