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

Operation succeeded. The operation returns the ExpressRoute gateway.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the express route gateway.
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_resource_group

Operation successful.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the express route gateway.
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_subscription

Request successful.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the express route gateway.
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	resourceGroupName, expressRouteGatewayName, 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	resourceGroupName, expressRouteGatewayName, subscriptionId		Creates or updates a ExpressRoute gateway in a specified resource group.
delete	delete	resourceGroupName, expressRouteGatewayName, 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	subscriptionId, resourceGroupName, expressRouteGatewayName		Updates express route gateway tags.

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
expressRouteGatewayName	string	The name of the gateway.
resourceGroupName	string	The resource group name of the ExpressRouteGateway.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

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

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.express_route_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND expressRouteGatewayName = '{{ expressRouteGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists ExpressRoute gateways in a given resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.express_route_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists ExpressRoute gateways under a given subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.express_route_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.network.express_route_gateways (
data__properties,
resourceGroupName,
expressRouteGatewayName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ expressRouteGatewayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the express_route_gateways resource.
    - name: expressRouteGatewayName
      value: string
      description: Required parameter for the express_route_gateways resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the express_route_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the express route gateway.

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 resourceGroupName = '{{ resourceGroupName }}' --required
AND expressRouteGatewayName = '{{ expressRouteGatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates express route gateway tags.

EXEC azure.network.express_route_gateways.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@expressRouteGatewayName='{{ expressRouteGatewayName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;