internet_gateways

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

Overview

Name	internet_gateways
Type	Resource
Id	azure_extras.managed_network_fabric.internet_gateways

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.
internetGatewayRuleId	string	ARM Resource ID of the Internet Gateway Rule.
internetGatewayType	string	Gateway Type of the resource. Known values are: "Infrastructure" and "Workload". (Infrastructure, Workload)
ipv4Address	string	IPv4 Address of Internet Gateway.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricControllerId	string	ARM Resource ID of the Network Fabric Controller. Required.
port	integer	Port number of Internet Gateway.
provisioningState	string	Provisioning state of resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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.
internetGatewayRuleId	string	ARM Resource ID of the Internet Gateway Rule.
internetGatewayType	string	Gateway Type of the resource. Known values are: "Infrastructure" and "Workload". (Infrastructure, Workload)
ipv4Address	string	IPv4 Address of Internet Gateway.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricControllerId	string	ARM Resource ID of the Network Fabric Controller. Required.
port	integer	Port number of Internet Gateway.
provisioningState	string	Provisioning state of resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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.
internetGatewayRuleId	string	ARM Resource ID of the Internet Gateway Rule.
internetGatewayType	string	Gateway Type of the resource. Known values are: "Infrastructure" and "Workload". (Infrastructure, Workload)
ipv4Address	string	IPv4 Address of Internet Gateway.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricControllerId	string	ARM Resource ID of the Network Fabric Controller. Required.
port	integer	Port number of Internet Gateway.
provisioningState	string	Provisioning state of resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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_name, subscription_id		Implements Gateway GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Displays Internet Gateways list by resource group GET method.
list_by_subscription	select	subscription_id		Displays Internet Gateways list by subscription GET method.
create	insert	resource_group_name, internet_gateway_name, subscription_id, location, properties		Creates a Network Fabric Service Internet Gateway resource instance.
update	update	resource_group_name, internet_gateway_name, subscription_id		Execute patch on Network Fabric Service Internet Gateway.
delete	delete	resource_group_name, internet_gateway_name, subscription_id		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
internet_gateway_name	string	Name of the Internet Gateway. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Implements Gateway GET method.

SELECT
id,
name,
annotation,
internetGatewayRuleId,
internetGatewayType,
ipv4Address,
lastOperation,
location,
networkFabricControllerId,
port,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.internet_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND internet_gateway_name = '{{ internet_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Displays Internet Gateways list by resource group GET method.

SELECT
id,
name,
annotation,
internetGatewayRuleId,
internetGatewayType,
ipv4Address,
lastOperation,
location,
networkFabricControllerId,
port,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.internet_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Displays Internet Gateways list by subscription GET method.

SELECT
id,
name,
annotation,
internetGatewayRuleId,
internetGatewayType,
ipv4Address,
lastOperation,
location,
networkFabricControllerId,
port,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.internet_gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Network Fabric Service Internet Gateway resource instance.

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

Manifest

# Description fields are for documentation purposes
- name: internet_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the internet_gateways resource.
  - name: internet_gateway_name
    value: "{{ internet_gateway_name }}"
    description: Required parameter for the internet_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the internet_gateways 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 Properties. Required.
    value:
      annotation: "{{ annotation }}"
      internetGatewayRuleId: "{{ internetGatewayRuleId }}"
      ipv4Address: "{{ ipv4Address }}"
      port: {{ port }}
      type: "{{ type }}"
      internetGatewayType: "{{ internetGatewayType }}"
      networkFabricControllerId: "{{ networkFabricControllerId }}"
      lastOperation:
        details: "{{ details }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Execute patch on Network Fabric Service Internet Gateway.

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

DELETE examples

delete

Execute a delete on Network Fabric Service Internet Gateway.

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