Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. VirtualNetworkGatewayNatRule

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-azure

azure.network.VirtualNetworkGatewayNatRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-azure

    Manages a Virtual Network Gateway Nat Rule.

    Create VirtualNetworkGatewayNatRule Resource

    new VirtualNetworkGatewayNatRule(name: string, args: VirtualNetworkGatewayNatRuleArgs, opts?: CustomResourceOptions);
    @overload
def VirtualNetworkGatewayNatRule(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 external_mappings: Optional[Sequence[VirtualNetworkGatewayNatRuleExternalMappingArgs]] = None,
                                 internal_mappings: Optional[Sequence[VirtualNetworkGatewayNatRuleInternalMappingArgs]] = None,
                                 ip_configuration_id: Optional[str] = None,
                                 mode: Optional[str] = None,
                                 name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 type: Optional[str] = None,
                                 virtual_network_gateway_id: Optional[str] = None)
@overload
def VirtualNetworkGatewayNatRule(resource_name: str,
                                 args: VirtualNetworkGatewayNatRuleArgs,
                                 opts: Optional[ResourceOptions] = None)
    func NewVirtualNetworkGatewayNatRule(ctx *Context, name string, args VirtualNetworkGatewayNatRuleArgs, opts ...ResourceOption) (*VirtualNetworkGatewayNatRule, error)
    public VirtualNetworkGatewayNatRule(string name, VirtualNetworkGatewayNatRuleArgs args, CustomResourceOptions? opts = null)
    public VirtualNetworkGatewayNatRule(String name, VirtualNetworkGatewayNatRuleArgs args)
public VirtualNetworkGatewayNatRule(String name, VirtualNetworkGatewayNatRuleArgs args, CustomResourceOptions options)

    type: azure:network:VirtualNetworkGatewayNatRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualNetworkGatewayNatRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualNetworkGatewayNatRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualNetworkGatewayNatRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualNetworkGatewayNatRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualNetworkGatewayNatRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VirtualNetworkGatewayNatRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VirtualNetworkGatewayNatRule resource accepts the following input properties:

    ExternalMappings List<VirtualNetworkGatewayNatRuleExternalMapping>

    One or more external_mapping blocks as documented below.

    InternalMappings List<VirtualNetworkGatewayNatRuleInternalMapping>

    One or more internal_mapping blocks as documented below.

    ResourceGroupName string

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    VirtualNetworkGatewayId string

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    IpConfigurationId string

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    Mode string

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    Name string

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    Type string

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    ExternalMappings []VirtualNetworkGatewayNatRuleExternalMappingArgs

    One or more external_mapping blocks as documented below.

    InternalMappings []VirtualNetworkGatewayNatRuleInternalMappingArgs

    One or more internal_mapping blocks as documented below.

    ResourceGroupName string

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    VirtualNetworkGatewayId string

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    IpConfigurationId string

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    Mode string

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    Name string

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    Type string

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    externalMappings List<VirtualNetworkGatewayNatRuleExternalMapping>

    One or more external_mapping blocks as documented below.

    internalMappings List<VirtualNetworkGatewayNatRuleInternalMapping>

    One or more internal_mapping blocks as documented below.

    resourceGroupName String

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    virtualNetworkGatewayId String

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    ipConfigurationId String

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode String

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name String

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    type String

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    externalMappings VirtualNetworkGatewayNatRuleExternalMapping[]

    One or more external_mapping blocks as documented below.

    internalMappings VirtualNetworkGatewayNatRuleInternalMapping[]

    One or more internal_mapping blocks as documented below.

    resourceGroupName string

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    virtualNetworkGatewayId string

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    ipConfigurationId string

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode string

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name string

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    type string

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    external_mappings Sequence[VirtualNetworkGatewayNatRuleExternalMappingArgs]

    One or more external_mapping blocks as documented below.

    internal_mappings Sequence[VirtualNetworkGatewayNatRuleInternalMappingArgs]

    One or more internal_mapping blocks as documented below.

    resource_group_name str

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    virtual_network_gateway_id str

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    ip_configuration_id str

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode str

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name str

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    type str

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    externalMappings List<Property Map>

    One or more external_mapping blocks as documented below.

    internalMappings List<Property Map>

    One or more internal_mapping blocks as documented below.

    resourceGroupName String

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    virtualNetworkGatewayId String

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    ipConfigurationId String

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode String

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name String

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    type String

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualNetworkGatewayNatRule resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing VirtualNetworkGatewayNatRule Resource

    Get an existing VirtualNetworkGatewayNatRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VirtualNetworkGatewayNatRuleState, opts?: CustomResourceOptions): VirtualNetworkGatewayNatRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        external_mappings: Optional[Sequence[VirtualNetworkGatewayNatRuleExternalMappingArgs]] = None,
        internal_mappings: Optional[Sequence[VirtualNetworkGatewayNatRuleInternalMappingArgs]] = None,
        ip_configuration_id: Optional[str] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        type: Optional[str] = None,
        virtual_network_gateway_id: Optional[str] = None) -> VirtualNetworkGatewayNatRule
    func GetVirtualNetworkGatewayNatRule(ctx *Context, name string, id IDInput, state *VirtualNetworkGatewayNatRuleState, opts ...ResourceOption) (*VirtualNetworkGatewayNatRule, error)
    public static VirtualNetworkGatewayNatRule Get(string name, Input<string> id, VirtualNetworkGatewayNatRuleState? state, CustomResourceOptions? opts = null)
    public static VirtualNetworkGatewayNatRule get(String name, Output<String> id, VirtualNetworkGatewayNatRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ExternalMappings List<VirtualNetworkGatewayNatRuleExternalMapping>

    One or more external_mapping blocks as documented below.

    InternalMappings List<VirtualNetworkGatewayNatRuleInternalMapping>

    One or more internal_mapping blocks as documented below.

    IpConfigurationId string

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    Mode string

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    Name string

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    ResourceGroupName string

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    Type string

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    VirtualNetworkGatewayId string

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    ExternalMappings []VirtualNetworkGatewayNatRuleExternalMappingArgs

    One or more external_mapping blocks as documented below.

    InternalMappings []VirtualNetworkGatewayNatRuleInternalMappingArgs

    One or more internal_mapping blocks as documented below.

    IpConfigurationId string

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    Mode string

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    Name string

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    ResourceGroupName string

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    Type string

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    VirtualNetworkGatewayId string

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    externalMappings List<VirtualNetworkGatewayNatRuleExternalMapping>

    One or more external_mapping blocks as documented below.

    internalMappings List<VirtualNetworkGatewayNatRuleInternalMapping>

    One or more internal_mapping blocks as documented below.

    ipConfigurationId String

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode String

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name String

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    resourceGroupName String

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    type String

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    virtualNetworkGatewayId String

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    externalMappings VirtualNetworkGatewayNatRuleExternalMapping[]

    One or more external_mapping blocks as documented below.

    internalMappings VirtualNetworkGatewayNatRuleInternalMapping[]

    One or more internal_mapping blocks as documented below.

    ipConfigurationId string

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode string

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name string

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    resourceGroupName string

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    type string

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    virtualNetworkGatewayId string

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    external_mappings Sequence[VirtualNetworkGatewayNatRuleExternalMappingArgs]

    One or more external_mapping blocks as documented below.

    internal_mappings Sequence[VirtualNetworkGatewayNatRuleInternalMappingArgs]

    One or more internal_mapping blocks as documented below.

    ip_configuration_id str

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode str

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name str

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    resource_group_name str

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    type str

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    virtual_network_gateway_id str

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    externalMappings List<Property Map>

    One or more external_mapping blocks as documented below.

    internalMappings List<Property Map>

    One or more internal_mapping blocks as documented below.

    ipConfigurationId String

    The ID of the IP Configuration this Virtual Network Gateway Nat Rule applies to.

    mode String

    The source Nat direction of the Virtual Network Gateway Nat. Possible values are EgressSnat and IngressSnat. Defaults to EgressSnat. Changing this forces a new resource to be created.

    name String

    The name which should be used for this Virtual Network Gateway Nat Rule. Changing this forces a new resource to be created.

    resourceGroupName String

    The Name of the Resource Group in which this Virtual Network Gateway Nat Rule should be created. Changing this forces a new resource to be created.

    type String

    The type of the Virtual Network Gateway Nat Rule. Possible values are Dynamic and Static. Defaults to Static. Changing this forces a new resource to be created.

    virtualNetworkGatewayId String

    The ID of the Virtual Network Gateway that this Virtual Network Gateway Nat Rule belongs to. Changing this forces a new resource to be created.

    Supporting Types

    VirtualNetworkGatewayNatRuleExternalMapping, VirtualNetworkGatewayNatRuleExternalMappingArgs

    AddressSpace string

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule external mapping.

    PortRange string

    The single port range for the Virtual Network Gateway Nat Rule external mapping.

    AddressSpace string

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule external mapping.

    PortRange string

    The single port range for the Virtual Network Gateway Nat Rule external mapping.

    addressSpace String

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule external mapping.

    portRange String

    The single port range for the Virtual Network Gateway Nat Rule external mapping.

    addressSpace string

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule external mapping.

    portRange string

    The single port range for the Virtual Network Gateway Nat Rule external mapping.

    address_space str

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule external mapping.

    port_range str

    The single port range for the Virtual Network Gateway Nat Rule external mapping.

    addressSpace String

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule external mapping.

    portRange String

    The single port range for the Virtual Network Gateway Nat Rule external mapping.

    VirtualNetworkGatewayNatRuleInternalMapping, VirtualNetworkGatewayNatRuleInternalMappingArgs

    AddressSpace string

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule internal mapping.

    PortRange string

    The single port range for the Virtual Network Gateway Nat Rule internal mapping.

    AddressSpace string

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule internal mapping.

    PortRange string

    The single port range for the Virtual Network Gateway Nat Rule internal mapping.

    addressSpace String

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule internal mapping.

    portRange String

    The single port range for the Virtual Network Gateway Nat Rule internal mapping.

    addressSpace string

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule internal mapping.

    portRange string

    The single port range for the Virtual Network Gateway Nat Rule internal mapping.

    address_space str

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule internal mapping.

    port_range str

    The single port range for the Virtual Network Gateway Nat Rule internal mapping.

    addressSpace String

    The string CIDR representing the address space for the Virtual Network Gateway Nat Rule internal mapping.

    portRange String

    The single port range for the Virtual Network Gateway Nat Rule internal mapping.

    Import

    Virtual Network Gateway Nat Rules can be imported using the resource id, e.g.

     $ pulumi import azure:network/virtualNetworkGatewayNatRule:VirtualNetworkGatewayNatRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/rule1

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
    pulumi/pulumi-azure