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

Request successful. The operation returns the resulting LocalNetworkGateway resource.

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 local network 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

Request successful. The operation returns a list of LocalNetworkGateway resources.

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 local network 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, localNetworkGatewayName, 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	resourceGroupName, localNetworkGatewayName, subscriptionId, data__properties		Creates or updates a local network gateway in the specified resource group.
delete	delete	resourceGroupName, localNetworkGatewayName, subscriptionId		Deletes the specified local network gateway.
update_tags	exec	resourceGroupName, localNetworkGatewayName, subscriptionId		Updates a local network 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
localNetworkGatewayName	string	The name of the local network gateway.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified local network gateway in a resource group.

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

list

Gets all the local network gateways in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.local_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
resourceGroupName,
localNetworkGatewayName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ localNetworkGatewayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: local_network_gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the local_network_gateways resource.
    - name: localNetworkGatewayName
      value: string
      description: Required parameter for the local_network_gateways resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the local_network_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the local network gateway.

DELETE examples

delete

Deletes the specified local network gateway.

DELETE FROM azure.network.local_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND localNetworkGatewayName = '{{ localNetworkGatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates a local network gateway tags.

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