Skip to main content

NatRule

Provides a NatRule from the Network group

Examples​

NatRulePut​

exports.createResources = () => [
  {
    type: "NatRule",
    group: "Network",
    name: "myNatRule",
    properties: () => ({
      properties: {
        type: "Static",
        mode: "EgressSnat",
        ipConfigurationId:
          "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
        internalMappings: [{ addressSpace: "10.4.0.0/24" }],
        externalMappings: [{ addressSpace: "192.168.21.0/24" }],
      },
    }),
    dependencies: ({}) => ({
      resourceGroup: "myResourceGroup",
      virtualHubIpConfiguration: "myVirtualHubIpConfiguration",
      gateway: "myVpnGateway",
    }),
  },
];

Dependencies​

Swagger Schema​

{
  properties: {
    properties: {
      'x-ms-client-flatten': true,
      description: 'Properties of the VpnGateway NAT rule.',
      properties: {
        provisioningState: {
          readOnly: true,
          description: 'The provisioning state of the NAT Rule resource.',
          type: 'string',
          enum: [ 'Succeeded', 'Updating', 'Deleting', 'Failed' ],
          'x-ms-enum': { name: 'ProvisioningState', modelAsString: true }
        },
        type: {
          type: 'string',
          description: 'The type of NAT rule for VPN NAT.',
          enum: [ 'Static', 'Dynamic' ],
          'x-ms-enum': { name: 'VpnNatRuleType', modelAsString: true }
        },
        mode: {
          type: 'string',
          description: 'The Source NAT direction of a VPN NAT.',
          enum: [ 'EgressSnat', 'IngressSnat' ],
          'x-ms-enum': { name: 'VpnNatRuleMode', modelAsString: true }
        },
        internalMappings: {
          type: 'array',
          items: {
            properties: {
              addressSpace: {
                type: 'string',
                description: 'Address space for Vpn NatRule mapping.'
              },
              portRange: {
                type: 'string',
                description: 'Port range for Vpn NatRule mapping.'
              }
            },
            description: 'Vpn NatRule mapping.'
          },
          description: 'The private IP address internal mapping for NAT.'
        },
        externalMappings: {
          type: 'array',
          items: {
            properties: {
              addressSpace: {
                type: 'string',
                description: 'Address space for Vpn NatRule mapping.'
              },
              portRange: {
                type: 'string',
                description: 'Port range for Vpn NatRule mapping.'
              }
            },
            description: 'Vpn NatRule mapping.'
          },
          description: 'The private IP address external mapping for NAT.'
        },
        ipConfigurationId: {
          type: 'string',
          description: 'The IP Configuration ID this NAT rule applies to.'
        },
        egressVpnSiteLinkConnections: {
          type: 'array',
          readOnly: true,
          items: {
            properties: { id: { type: 'string', description: 'Resource ID.' } },
            description: 'Reference to another subresource.',
            'x-ms-azure-resource': true
          },
          description: 'List of egress VpnSiteLinkConnections.'
        },
        ingressVpnSiteLinkConnections: {
          type: 'array',
          readOnly: true,
          items: {
            properties: { id: { type: 'string', description: 'Resource ID.' } },
            description: 'Reference to another subresource.',
            'x-ms-azure-resource': true
          },
          description: 'List of ingress VpnSiteLinkConnections.'
        }
      }
    },
    name: {
      type: 'string',
      description: 'The name of the resource that is unique within a resource group. This name can be used to access the resource.'
    },
    etag: {
      type: 'string',
      readOnly: true,
      description: 'A unique read-only string that changes whenever the resource is updated.'
    },
    type: { readOnly: true, type: 'string', description: 'Resource type.' }
  },
  allOf: [
    {
      properties: { id: { type: 'string', description: 'Resource ID.' } },
      description: 'Reference to another subresource.',
      'x-ms-azure-resource': true
    }
  ],
  description: 'VpnGatewayNatRule Resource.'
}

Misc​

The resource version is 2022-01-01.

The Swagger schema used to generate this documentation can be found here.