internet_gateways

Creates, updates, deletes, gets or lists an internet_gateways resource.

Overview

Name	internet_gateways
Type	Resource
Id	azure.managed_network_fabric.internet_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Lists all InternetGateways under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_subscription

Lists all Internet Gateways under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, internetGatewayName		Implements Gateway GET method.
list_by_resource_group	select	subscriptionId, resourceGroupName		Displays Internet Gateways list by resource group GET method.
list_by_subscription	select	subscriptionId		Displays Internet Gateways list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, internetGatewayName, data__properties		Creates a Network Fabric Service Internet Gateway resource instance.
update	update	subscriptionId, resourceGroupName, internetGatewayName		Execute patch on Network Fabric Service Internet Gateway.
delete	delete	subscriptionId, resourceGroupName, internetGatewayName		Execute a delete on Network Fabric Service Internet 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
internetGatewayName	string	Name of the Internet Gateway.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Implements Gateway GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.internet_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND internetGatewayName = '{{ internetGatewayName }}' -- required
;

list_by_resource_group

Displays Internet Gateways list by resource group GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.internet_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Displays Internet Gateways list by subscription GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.internet_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a Network Fabric Service Internet Gateway resource instance.

INSERT INTO azure.managed_network_fabric.internet_gateways (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
internetGatewayName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ internetGatewayName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: internet_gateways
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the internet_gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the internet_gateways resource.
    - name: internetGatewayName
      value: string
      description: Required parameter for the internet_gateways resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Execute patch on Network Fabric Service Internet Gateway.

UPDATE azure.managed_network_fabric.internet_gateways
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND internetGatewayName = '{{ internetGatewayName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Execute a delete on Network Fabric Service Internet Gateway.

DELETE FROM azure.managed_network_fabric.internet_gateways
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND internetGatewayName = '{{ internetGatewayName }}' --required
;