express_route_gateways

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

Overview

Name	express_route_gateways
Type	Resource
Id	azure.network.express_route_gateways

Fields

vw_express_route_gateways

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
allow_non_virtual_wan_traffic	text	field from the properties object
auto_scale_configuration	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
expressRouteGatewayName	text	field from the properties object
express_route_connections	text	field from the properties object
location	text	Resource location.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtual_hub	text	field from the properties object

express_route_gateways

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	ExpressRoute gateway resource properties.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	expressRouteGatewayName, resourceGroupName, subscriptionId	Fetches the details of a ExpressRoute gateway in a resource group.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists ExpressRoute gateways in a given resource group.
list_by_subscription	SELECT	subscriptionId	Lists ExpressRoute gateways under a given subscription.
create_or_update	INSERT	expressRouteGatewayName, resourceGroupName, subscriptionId	Creates or updates a ExpressRoute gateway in a specified resource group.
delete	DELETE	expressRouteGatewayName, resourceGroupName, subscriptionId	Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
update_tags	EXEC	expressRouteGatewayName, resourceGroupName, subscriptionId	Updates express route gateway tags.

SELECT examples

Lists ExpressRoute gateways under a given subscription.

vw_express_route_gateways

SELECT
id,
name,
allow_non_virtual_wan_traffic,
auto_scale_configuration,
etag,
expressRouteGatewayName,
express_route_connections,
location,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
virtual_hub
FROM azure.network.vw_express_route_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

express_route_gateways

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.express_route_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new express_route_gateways resource.

All Properties

/*+ create */
INSERT INTO azure.network.express_route_gateways (
expressRouteGatewayName,
resourceGroupName,
subscriptionId,
properties,
id,
location,
tags
)
SELECT 
'{{ expressRouteGatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: autoScaleConfiguration
          value: string
        - name: expressRouteConnections
          value:
            - - name: properties
                value:
                  - name: provisioningState
                    value: []
                  - name: expressRouteCircuitPeering
                    value:
                      - name: id
                        value: string
                  - name: authorizationKey
                    value: string
                  - name: routingWeight
                    value: integer
                  - name: enableInternetSecurity
                    value: boolean
                  - name: expressRouteGatewayBypass
                    value: boolean
                  - name: enablePrivateLinkFastPath
                    value: boolean
                  - name: routingConfiguration
                    value:
                      - name: associatedRouteTable
                        value:
                          - name: id
                            value: string
                      - name: propagatedRouteTables
                        value:
                          - name: labels
                            value:
                              - string
                          - name: ids
                            value:
                              - - name: id
                                  value: string
                      - name: vnetRoutes
                        value:
                          - name: staticRoutesConfig
                            value:
                              - name: propagateStaticRoutes
                                value: boolean
                              - name: vnetLocalRouteOverrideCriteria
                                value: []
                          - name: staticRoutes
                            value:
                              - - name: name
                                  value: string
                                - name: addressPrefixes
                                  value:
                                    - string
                                - name: nextHopIpAddress
                                  value: string
                          - name: bgpConnections
                            value:
                              - - name: id
                                  value: string
              - name: name
                value: string
              - name: id
                value: string
        - name: virtualHub
          value:
            - name: id
              value: string
        - name: allowNonVirtualWanTraffic
          value: boolean
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified express_route_gateways resource.

/*+ delete */
DELETE FROM azure.network.express_route_gateways
WHERE expressRouteGatewayName = '{{ expressRouteGatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';