Table: azure_virtual_network_gateway - Query Azure Virtual Network Gateways using SQL
Azure Virtual Network Gateway is a component used to send network traffic between Azure virtual networks and on-premises locations. It works as a specific type of virtual network gateway, designed to send encrypted traffic between an Azure virtual network and an on-premises location over the public Internet. It also enables communication between Azure virtual networks.
Table Usage Guide
The azure_virtual_network_gateway
table provides insights into the configuration and status of Azure Virtual Network Gateways. As a network administrator, explore gateway-specific details through this table, including its IP configuration, SKU, and associated virtual network. Utilize it to manage and monitor your network gateways, ensuring secure and efficient communication between your Azure virtual networks and on-premises locations.
Examples
Basic info
Explore which Azure Virtual Network Gateways have Border Gateway Protocol (BGP) enabled. This can be useful for network administrators seeking to understand their network's configuration and routing protocols.
select name, id, enable_bgp, region, resource_groupfrom azure_virtual_network_gateway;
select name, id, enable_bgp, region, resource_groupfrom azure_virtual_network_gateway;
List network gateways with no connections
Discover the segments of your Azure virtual network gateways that are not connected to any resources. This can help in identifying unused network gateways, potentially reducing infrastructure costs and improving network management.
select name, id, enable_bgp, region, resource_groupfrom azure_virtual_network_gatewaywhere gateway_connections is null;
select name, id, enable_bgp, region, resource_groupfrom azure_virtual_network_gatewaywhere gateway_connections is null;
Control examples
Schema for azure_virtual_network_gateway
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
active_active | boolean | Indicates whether virtual network gateway configured with active-active mode, or not. If true, each Azure gateway instance will have a unique public IP address, and each will establish an IPsec/IKE S2S VPN tunnel to your on-premises VPN device specified in your local network gateway and connection. | |
akas | jsonb | Array of globally unique identifier strings (also known as) for the resource. | |
bgp_settings | jsonb | Virtual network gateway's BGP speaker settings. | |
cloud_environment | text | The Azure Cloud Environment. | |
custom_routes_address_prefixes | jsonb | A list of address blocks reserved for this virtual network in CIDR notation. | |
enable_bgp | boolean | Indicates whether BGP is enabled for this virtual network gateway, or not. | |
enable_dns_forwarding | boolean | Indicates whether DNS forwarding is enabled, or not. | |
enable_private_ip_address | boolean | Indicates whether private IP needs to be enabled on this gateway for connections or not. | |
etag | text | An unique read-only string that changes whenever the resource is updated. | |
gateway_connections | jsonb | A list of virtual network gateway connection resources that exists in a resource group. | |
gateway_default_site | text | The reference to the LocalNetworkGateway resource, which represents local network site having default routes. Assign Null value in case of removing existing default site setting. | |
gateway_type | text | The type of this virtual network gateway. Possible values include: 'Vpn', 'ExpressRoute'. | |
id | text | Contains ID to identify a virtual network gateway uniquely. | |
inbound_dns_forwarding_endpoint | text | The IP address allocated by the gateway to which dns requests can be sent. | |
ip_configurations | jsonb | IP configurations for virtual network gateway. | |
name | text | = | The friendly name that identifies the virtual network gateway. |
provisioning_state | text | The provisioning state of the virtual network gateway resource. | |
region | text | The Azure region/location in which the resource is located. | |
resource_group | text | = | The resource group which holds this resource. |
resource_guid | text | The resource GUID property of the virtual network gateway resource. | |
sku_capacity | bigint | Gateway SKU capacity. | |
sku_name | text | Gateway SKU name. | |
sku_tier | text | Gateway SKU tier. | |
sp_connection_name | text | =, !=, ~~, ~~*, !~~, !~~* | Steampipe connection name. |
sp_ctx | jsonb | Steampipe context in JSON form. | |
subscription_id | text | =, !=, ~~, ~~*, !~~, !~~* | The Azure Subscription ID in which the resource is located. |
tags | jsonb | A map of tags for the resource. | |
title | text | Title of the resource. | |
type | text | Type of the resource. | |
vpn_client_configuration | jsonb | The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. | |
vpn_gateway_generation | text | The generation for this virtual network gateway. Must be None if gatewayType is not VPN. Valid values are: 'None', 'Generation1', 'Generation2'. | |
vpn_type | text | The type of this virtual network gateway. Valid values are: 'PolicyBased', 'RouteBased'. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- azure
You can pass the configuration to the command with the --config
argument:
steampipe_export_azure --config '<your_config>' azure_virtual_network_gateway