internet_gateway_rules

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

Overview

Name	internet_gateway_rules
Type	Resource
Id	azure.managed_network_fabric.internet_gateway_rules

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 Internet Gateway Rules 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 Gateway Rules 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, internetGatewayRuleName		Gets an Internet Gateway Rule resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		Implements Internet Gateway Rules list by resource group GET method.
list_by_subscription	select	subscriptionId		List all Internet Gateway rules in the given subscription.
create	insert	subscriptionId, resourceGroupName, internetGatewayRuleName, data__properties		Creates an Internet Gateway rule resource.
update	update	subscriptionId, resourceGroupName, internetGatewayRuleName		API to update certain properties of the Internet Gateway Rule resource.
delete	delete	subscriptionId, resourceGroupName, internetGatewayRuleName		Implements Internet Gateway Rules DELETE method.

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
internetGatewayRuleName	string	Name of the Internet Gateway rule.
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

Gets an Internet Gateway Rule resource.

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

list_by_resource_group

Implements Internet Gateway Rules list by resource group GET method.

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

list_by_subscription

List all Internet Gateway rules in the given subscription.

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

INSERT examples

create

Creates an Internet Gateway rule resource.

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

Manifest

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

UPDATE examples

update

API to update certain properties of the Internet Gateway Rule resource.

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

DELETE examples

delete

Implements Internet Gateway Rules DELETE method.

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