internet_gateway_rules

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

Overview

Name	internet_gateway_rules
Type	Resource
Id	azure_extras.managed_network_fabric.internet_gateway_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotation	string	Switch configuration description.
internetGatewayIds	array	List of Internet Gateway resource Id.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
ruleProperties	object	Rules for the InternetGateways. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotation	string	Switch configuration description.
internetGatewayIds	array	List of Internet Gateway resource Id.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
ruleProperties	object	Rules for the InternetGateways. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotation	string	Switch configuration description.
internetGatewayIds	array	List of Internet Gateway resource Id.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
ruleProperties	object	Rules for the InternetGateways. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, internet_gateway_rule_name, subscription_id		Gets an Internet Gateway Rule resource.
list_by_resource_group	select	resource_group_name, subscription_id		Implements Internet Gateway Rules list by resource group GET method.
list_by_subscription	select	subscription_id		List all Internet Gateway rules in the given subscription.
create	insert	resource_group_name, internet_gateway_rule_name, subscription_id, location, properties		Creates an Internet Gateway rule resource.
update	update	resource_group_name, internet_gateway_rule_name, subscription_id		API to update certain properties of the Internet Gateway Rule resource.
delete	delete	resource_group_name, internet_gateway_rule_name, subscription_id		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
internet_gateway_rule_name	string	Name of the Internet Gateway rule. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an Internet Gateway Rule resource.

SELECT
id,
name,
annotation,
internetGatewayIds,
lastOperation,
location,
provisioningState,
ruleProperties,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.internet_gateway_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND internet_gateway_rule_name = '{{ internet_gateway_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements Internet Gateway Rules list by resource group GET method.

SELECT
id,
name,
annotation,
internetGatewayIds,
lastOperation,
location,
provisioningState,
ruleProperties,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.internet_gateway_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all Internet Gateway rules in the given subscription.

SELECT
id,
name,
annotation,
internetGatewayIds,
lastOperation,
location,
provisioningState,
ruleProperties,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.internet_gateway_rules
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an Internet Gateway rule resource.

INSERT INTO azure_extras.managed_network_fabric.internet_gateway_rules (
tags,
location,
properties,
resource_group_name,
internet_gateway_rule_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ internet_gateway_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: internet_gateway_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the internet_gateway_rules resource.
  - name: internet_gateway_rule_name
    value: "{{ internet_gateway_rule_name }}"
    description: Required parameter for the internet_gateway_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the internet_gateway_rules resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The Internet Gateway Rule properties. Required.
    value:
      annotation: "{{ annotation }}"
      ruleProperties:
        action: "{{ action }}"
        addressList:
          - "{{ addressList }}"
        condition: "{{ condition }}"
        destinationAddressList:
          - "{{ destinationAddressList }}"
        sourceAddressList:
          - "{{ sourceAddressList }}"
        headerAddressList:
          - headerName: "{{ headerName }}"
            addressList: "{{ addressList }}"
      lastOperation:
        details: "{{ details }}"
      provisioningState: "{{ provisioningState }}"
      internetGatewayIds:
        - "{{ internetGatewayIds }}"

UPDATE examples

update

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

UPDATE azure_extras.managed_network_fabric.internet_gateway_rules
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND internet_gateway_rule_name = '{{ internet_gateway_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Implements Internet Gateway Rules DELETE method.

DELETE FROM azure_extras.managed_network_fabric.internet_gateway_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND internet_gateway_rule_name = '{{ internet_gateway_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;