1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getNatGateway
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.azurestackhci.getNatGateway

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    The operation to get a natGateway.

    Uses Azure REST API version 2025-09-01-preview.

    Using getNatGateway

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNatGateway(args: GetNatGatewayArgs, opts?: InvokeOptions): Promise<GetNatGatewayResult>
function getNatGatewayOutput(args: GetNatGatewayOutputArgs, opts?: InvokeOptions): Output<GetNatGatewayResult>
    def get_nat_gateway(nat_gateway_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNatGatewayResult
def get_nat_gateway_output(nat_gateway_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNatGatewayResult]
    func LookupNatGateway(ctx *Context, args *LookupNatGatewayArgs, opts ...InvokeOption) (*LookupNatGatewayResult, error)
func LookupNatGatewayOutput(ctx *Context, args *LookupNatGatewayOutputArgs, opts ...InvokeOption) LookupNatGatewayResultOutput

    > Note: This function is named LookupNatGateway in the Go SDK.

    public static class GetNatGateway 
{
    public static Task<GetNatGatewayResult> InvokeAsync(GetNatGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetNatGatewayResult> Invoke(GetNatGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNatGatewayResult> getNatGateway(GetNatGatewayArgs args, InvokeOptions options)
public static Output<GetNatGatewayResult> getNatGateway(GetNatGatewayArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurestackhci:getNatGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NatGatewayName string
    Name of the nat gateway
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    NatGatewayName string
    Name of the nat gateway
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    natGatewayName String
    Name of the nat gateway
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    natGatewayName string
    Name of the nat gateway
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    nat_gateway_name str
    Name of the nat gateway
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    natGatewayName String
    Name of the nat gateway
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getNatGateway Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureStackHCI.Outputs.NatGatewayPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
    The extendedLocation of the resource.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties NatGatewayPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties NatGatewayPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties NatGatewayPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties NatGatewayPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extended_location ExtendedLocationResponse
    The extendedLocation of the resource.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation Property Map
    The extendedLocation of the resource.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    IPConfigurationArmReferenceResponse

    ResourceId string
    The Azure Resource ID of an IPConfiguration resource
    ResourceId string
    The Azure Resource ID of an IPConfiguration resource
    resourceId String
    The Azure Resource ID of an IPConfiguration resource
    resourceId string
    The Azure Resource ID of an IPConfiguration resource
    resource_id str
    The Azure Resource ID of an IPConfiguration resource
    resourceId String
    The Azure Resource ID of an IPConfiguration resource

    InboundNATRulePropertiesResponse

    BackendIPConfiguration Pulumi.AzureNative.AzureStackHCI.Inputs.IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    BackendPort int
    backend Port for the inbound rule
    FrontendPort int
    Frontend Port for the inbound rule
    Protocol string
    Protocol for the NAT rule
    PublicIPAddress Pulumi.AzureNative.AzureStackHCI.Inputs.PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    BackendIPConfiguration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    BackendPort int
    backend Port for the inbound rule
    FrontendPort int
    Frontend Port for the inbound rule
    Protocol string
    Protocol for the NAT rule
    PublicIPAddress PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    backendIPConfiguration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    backendPort Integer
    backend Port for the inbound rule
    frontendPort Integer
    Frontend Port for the inbound rule
    protocol String
    Protocol for the NAT rule
    publicIPAddress PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    backendIPConfiguration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    backendPort number
    backend Port for the inbound rule
    frontendPort number
    Frontend Port for the inbound rule
    protocol string
    Protocol for the NAT rule
    publicIPAddress PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    backend_ip_configuration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    backend_port int
    backend Port for the inbound rule
    frontend_port int
    Frontend Port for the inbound rule
    protocol str
    Protocol for the NAT rule
    public_ip_address PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    backendIPConfiguration Property Map
    IP configuration for the target backend.
    backendPort Number
    backend Port for the inbound rule
    frontendPort Number
    Frontend Port for the inbound rule
    protocol String
    Protocol for the NAT rule
    publicIPAddress Property Map
    Public IP Address for this NAT rule

    InboundNATRuleResponse

    Name string
    name of the inbound nat rule
    Properties Pulumi.AzureNative.AzureStackHCI.Inputs.InboundNATRulePropertiesResponse
    properties of the inbound nat rule
    Name string
    name of the inbound nat rule
    Properties InboundNATRulePropertiesResponse
    properties of the inbound nat rule
    name String
    name of the inbound nat rule
    properties InboundNATRulePropertiesResponse
    properties of the inbound nat rule
    name string
    name of the inbound nat rule
    properties InboundNATRulePropertiesResponse
    properties of the inbound nat rule
    name str
    name of the inbound nat rule
    properties InboundNATRulePropertiesResponse
    properties of the inbound nat rule
    name String
    name of the inbound nat rule
    properties Property Map
    properties of the inbound nat rule

    NatGatewayPropertiesResponse

    ProvisioningState string
    Provisioning state of the public IP
    Status Pulumi.AzureNative.AzureStackHCI.Inputs.NatGatewayStatusResponse
    The observed state of Nat Gateway
    Subnets List<Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualNetworkSubnetArmReferenceResponse>
    List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet
    InboundNATRules List<Pulumi.AzureNative.AzureStackHCI.Inputs.InboundNATRuleResponse>
    List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet
    PublicIPAddresses List<Pulumi.AzureNative.AzureStackHCI.Inputs.PublicIPAddressArmReferenceResponse>
    List of public ip addresses that the gateway can use for NAT.
    ProvisioningState string
    Provisioning state of the public IP
    Status NatGatewayStatusResponse
    The observed state of Nat Gateway
    Subnets []VirtualNetworkSubnetArmReferenceResponse
    List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet
    InboundNATRules []InboundNATRuleResponse
    List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet
    PublicIPAddresses []PublicIPAddressArmReferenceResponse
    List of public ip addresses that the gateway can use for NAT.
    provisioningState String
    Provisioning state of the public IP
    status NatGatewayStatusResponse
    The observed state of Nat Gateway
    subnets List<VirtualNetworkSubnetArmReferenceResponse>
    List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet
    inboundNATRules List<InboundNATRuleResponse>
    List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet
    publicIPAddresses List<PublicIPAddressArmReferenceResponse>
    List of public ip addresses that the gateway can use for NAT.
    provisioningState string
    Provisioning state of the public IP
    status NatGatewayStatusResponse
    The observed state of Nat Gateway
    subnets VirtualNetworkSubnetArmReferenceResponse[]
    List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet
    inboundNATRules InboundNATRuleResponse[]
    List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet
    publicIPAddresses PublicIPAddressArmReferenceResponse[]
    List of public ip addresses that the gateway can use for NAT.
    provisioning_state str
    Provisioning state of the public IP
    status NatGatewayStatusResponse
    The observed state of Nat Gateway
    subnets Sequence[VirtualNetworkSubnetArmReferenceResponse]
    List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet
    inbound_nat_rules Sequence[InboundNATRuleResponse]
    List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet
    public_ip_addresses Sequence[PublicIPAddressArmReferenceResponse]
    List of public ip addresses that the gateway can use for NAT.
    provisioningState String
    Provisioning state of the public IP
    status Property Map
    The observed state of Nat Gateway
    subnets List<Property Map>
    List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet
    inboundNATRules List<Property Map>
    List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet
    publicIPAddresses List<Property Map>
    List of public ip addresses that the gateway can use for NAT.

    NatGatewayStatusProvisioningStatusResponse

    Status string
    The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the nat gateway
    Status string
    The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the nat gateway
    status String
    The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the nat gateway
    status string
    The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress]
    operationId string
    The ID of the operation performed on the nat gateway
    status str
    The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress]
    operation_id str
    The ID of the operation performed on the nat gateway
    status String
    The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the nat gateway

    NatGatewayStatusResponse

    ErrorCode string
    NatGateway provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.NatGatewayStatusProvisioningStatusResponse
    NatGateway provisioning status
    ErrorCode string
    NatGateway provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus NatGatewayStatusProvisioningStatusResponse
    NatGateway provisioning status
    errorCode String
    NatGateway provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus NatGatewayStatusProvisioningStatusResponse
    NatGateway provisioning status
    errorCode string
    NatGateway provisioning error code
    errorMessage string
    Descriptive error message
    provisioningStatus NatGatewayStatusProvisioningStatusResponse
    NatGateway provisioning status
    error_code str
    NatGateway provisioning error code
    error_message str
    Descriptive error message
    provisioning_status NatGatewayStatusProvisioningStatusResponse
    NatGateway provisioning status
    errorCode String
    NatGateway provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus Property Map
    NatGateway provisioning status

    PublicIPAddressArmReferenceResponse

    ResourceId string
    The Azure Resource ID of a Public IP resource
    ResourceId string
    The Azure Resource ID of a Public IP resource
    resourceId String
    The Azure Resource ID of a Public IP resource
    resourceId string
    The Azure Resource ID of a Public IP resource
    resource_id str
    The Azure Resource ID of a Public IP resource
    resourceId String
    The Azure Resource ID of a Public IP resource

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VirtualNetworkSubnetArmReferenceResponse

    ResourceId string
    The Azure Resource ID for a Virtual Network subnet.
    ResourceId string
    The Azure Resource ID for a Virtual Network subnet.
    resourceId String
    The Azure Resource ID for a Virtual Network subnet.
    resourceId string
    The Azure Resource ID for a Virtual Network subnet.
    resource_id str
    The Azure Resource ID for a Virtual Network subnet.
    resourceId String
    The Azure Resource ID for a Virtual Network subnet.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate