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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bgpSettings	object	Local network gateway's BGP speaker settings.
etag	string	A unique read-only string that changes whenever the resource is updated.
fqdn	string	FQDN of local network gateway.
gatewayIpAddress	string	IP address of local network gateway.
localNetworkAddressSpace	object	Local network site address space.
location	string	Resource location.
provisioningState	string	The provisioning state of the local network gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the local network gateway resource.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bgpSettings	object	Local network gateway's BGP speaker settings.
etag	string	A unique read-only string that changes whenever the resource is updated.
fqdn	string	FQDN of local network gateway.
gatewayIpAddress	string	IP address of local network gateway.
localNetworkAddressSpace	object	Local network site address space.
location	string	Resource location.
provisioningState	string	The provisioning state of the local network gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the local network gateway resource.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, local_network_gateway_name, subscription_id		Gets the specified local network gateway in a resource group.
list	select	resource_group_name, subscription_id		Gets all the local network gateways in a resource group.
create_or_update	insert	resource_group_name, local_network_gateway_name, subscription_id, properties		Creates or updates a local network gateway in the specified resource group.
update_tags	update	resource_group_name, local_network_gateway_name, subscription_id		Updates a local network gateway tags.
create_or_update	replace	resource_group_name, local_network_gateway_name, subscription_id, properties		Creates or updates a local network gateway in the specified resource group.
delete	delete	resource_group_name, local_network_gateway_name, subscription_id		Deletes the specified local network gateway.

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
local_network_gateway_name	string	The name of the local network gateway. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified local network gateway in a resource group.

SELECT
id,
name,
bgpSettings,
etag,
fqdn,
gatewayIpAddress,
localNetworkAddressSpace,
location,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.local_network_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND local_network_gateway_name = '{{ local_network_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the local network gateways in a resource group.

SELECT
id,
name,
bgpSettings,
etag,
fqdn,
gatewayIpAddress,
localNetworkAddressSpace,
location,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.local_network_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a local network gateway in the specified resource group.

INSERT INTO azure.network.local_network_gateways (
id,
location,
tags,
properties,
resource_group_name,
local_network_gateway_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ local_network_gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: local_network_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the local_network_gateways resource.
  - name: local_network_gateway_name
    value: "{{ local_network_gateway_name }}"
    description: Required parameter for the local_network_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the local_network_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 local network gateway. Required.
    value:
      localNetworkAddressSpace:
        addressPrefixes:
          - "{{ addressPrefixes }}"
        ipamPoolPrefixAllocations:
          - pool:
              id: "{{ id }}"
            numberOfIpAddresses: "{{ numberOfIpAddresses }}"
            allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
      gatewayIpAddress: "{{ gatewayIpAddress }}"
      fqdn: "{{ fqdn }}"
      bgpSettings:
        asn: {{ asn }}
        bgpPeeringAddress: "{{ bgpPeeringAddress }}"
        peerWeight: {{ peerWeight }}
        bgpPeeringAddresses:
          - ipconfigurationId: "{{ ipconfigurationId }}"
            defaultBgpIpAddresses: "{{ defaultBgpIpAddresses }}"
            customBgpIpAddresses: "{{ customBgpIpAddresses }}"
            tunnelIpAddresses: "{{ tunnelIpAddresses }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update_tags

Updates a local network gateway tags.

UPDATE azure.network.local_network_gateways
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND local_network_gateway_name = '{{ local_network_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 local network gateway in the specified resource group.

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

DELETE examples

delete

Deletes the specified local network gateway.

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