inbound_nat_rules

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

Overview

Name	inbound_nat_rules
Type	Resource
Id	azure.network.inbound_nat_rules

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting InboundNatRule resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of load balancer inbound NAT rule.
type	string	Type of the resource.

list

Request successful. The operation returns a list of LoadBalancer InboundNatRule resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of load balancer inbound NAT rule.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, loadBalancerName, inboundNatRuleName, subscriptionId	$expand	Gets the specified load balancer inbound NAT rule.
list	select	resourceGroupName, loadBalancerName, subscriptionId		Gets all the inbound NAT rules in a load balancer.
create_or_update	insert	resourceGroupName, loadBalancerName, inboundNatRuleName, subscriptionId		Creates or updates a load balancer inbound NAT rule.
delete	delete	resourceGroupName, loadBalancerName, inboundNatRuleName, subscriptionId		Deletes the specified load balancer inbound NAT rule.

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
inboundNatRuleName	string	The name of the inbound NAT rule.
loadBalancerName	string	The name of the load balancer.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified load balancer inbound NAT rule.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.inbound_nat_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND loadBalancerName = '{{ loadBalancerName }}' -- required
AND inboundNatRuleName = '{{ inboundNatRuleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all the inbound NAT rules in a load balancer.

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

INSERT examples

create_or_update

Creates or updates a load balancer inbound NAT rule.

INSERT INTO azure.network.inbound_nat_rules (
data__properties,
data__name,
data__id,
resourceGroupName,
loadBalancerName,
inboundNatRuleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ loadBalancerName }}',
'{{ inboundNatRuleName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: inbound_nat_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the inbound_nat_rules resource.
    - name: loadBalancerName
      value: string
      description: Required parameter for the inbound_nat_rules resource.
    - name: inboundNatRuleName
      value: string
      description: Required parameter for the inbound_nat_rules resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the inbound_nat_rules resource.
    - name: properties
      value: object
      description: |
        Properties of load balancer inbound NAT rule.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified load balancer inbound NAT rule.

DELETE FROM azure.network.inbound_nat_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND loadBalancerName = '{{ loadBalancerName }}' --required
AND inboundNatRuleName = '{{ inboundNatRuleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;