local_network_gateways

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

Overview

Name	local_network_gateways
Type	Resource
Id	azure.network.local_network_gateways

Fields

vw_local_network_gateways

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
bgp_settings	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
fqdn	text	field from the properties object
gateway_ip_address	text	field from the properties object
localNetworkGatewayName	text	field from the properties object
local_network_address_space	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
resource_guid	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.

local_network_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	LocalNetworkGateway properties.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	localNetworkGatewayName, resourceGroupName, subscriptionId	Gets the specified local network gateway in a resource group.
list	SELECT	resourceGroupName, subscriptionId	Gets all the local network gateways in a resource group.
create_or_update	INSERT	localNetworkGatewayName, resourceGroupName, subscriptionId, data__properties	Creates or updates a local network gateway in the specified resource group.
delete	DELETE	localNetworkGatewayName, resourceGroupName, subscriptionId	Deletes the specified local network gateway.
update_tags	EXEC	localNetworkGatewayName, resourceGroupName, subscriptionId	Updates a local network gateway tags.

SELECT examples

Gets all the local network gateways in a resource group.

vw_local_network_gateways

SELECT
id,
name,
bgp_settings,
etag,
fqdn,
gateway_ip_address,
localNetworkGatewayName,
local_network_address_space,
location,
provisioning_state,
resourceGroupName,
resource_guid,
subscriptionId,
tags,
type
FROM azure.network.vw_local_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

local_network_gateways

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: localNetworkAddressSpace
          value:
            - name: addressPrefixes
              value:
                - string
        - name: gatewayIpAddress
          value: string
        - name: fqdn
          value: string
        - name: bgpSettings
          value:
            - name: asn
              value: integer
            - name: bgpPeeringAddress
              value: string
            - name: peerWeight
              value: integer
            - name: bgpPeeringAddresses
              value:
                - - name: ipconfigurationId
                    value: string
                  - name: defaultBgpIpAddresses
                    value:
                      - string
                  - name: customBgpIpAddresses
                    value:
                      - string
                  - name: tunnelIpAddresses
                    value:
                      - string
        - name: resourceGuid
          value: string
        - name: provisioningState
          value: []
    - 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 local_network_gateways resource.

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