azure-native.network.getNatGateway
Explore with Pulumi AI
Gets the specified nat gateway in a specified resource group. API Version: 2020-11-01.
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(expand: Optional[str] = None,
nat_gateway_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNatGatewayResult
def get_nat_gateway_output(expand: Optional[pulumi.Input[str]] = None,
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:network:getNatGateway
arguments:
# arguments dictionary
The following arguments are supported:
- Nat
Gateway stringName The name of the nat gateway.
- Resource
Group stringName The name of the resource group.
- Expand string
Expands referenced resources.
- Nat
Gateway stringName The name of the nat gateway.
- Resource
Group stringName The name of the resource group.
- Expand string
Expands referenced resources.
- nat
Gateway StringName The name of the nat gateway.
- resource
Group StringName The name of the resource group.
- expand String
Expands referenced resources.
- nat
Gateway stringName The name of the nat gateway.
- resource
Group stringName The name of the resource group.
- expand string
Expands referenced resources.
- nat_
gateway_ strname The name of the nat gateway.
- resource_
group_ strname The name of the resource group.
- expand str
Expands referenced resources.
- nat
Gateway StringName The name of the nat gateway.
- resource
Group StringName The name of the resource group.
- expand String
Expands referenced resources.
getNatGateway Result
The following output properties are available:
- Etag string
A unique read-only string that changes whenever the resource is updated.
- Name string
Resource name.
- Provisioning
State string The provisioning state of the NAT gateway resource.
- Resource
Guid string The resource GUID property of the NAT gateway resource.
- Subnets
List<Pulumi.
Azure Native. Network. Outputs. Sub Resource Response> An array of references to the subnets using this nat gateway resource.
- Type string
Resource type.
- Id string
Resource ID.
- Idle
Timeout intIn Minutes The idle timeout of the nat gateway.
- Location string
Resource location.
- Public
Ip List<Pulumi.Addresses Azure Native. Network. Outputs. Sub Resource Response> An array of public ip addresses associated with the nat gateway resource.
- Public
Ip List<Pulumi.Prefixes Azure Native. Network. Outputs. Sub Resource Response> An array of public ip prefixes associated with the nat gateway resource.
- Sku
Pulumi.
Azure Native. Network. Outputs. Nat Gateway Sku Response The nat gateway SKU.
- Dictionary<string, string>
Resource tags.
- Zones List<string>
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
- Etag string
A unique read-only string that changes whenever the resource is updated.
- Name string
Resource name.
- Provisioning
State string The provisioning state of the NAT gateway resource.
- Resource
Guid string The resource GUID property of the NAT gateway resource.
- Subnets
[]Sub
Resource Response An array of references to the subnets using this nat gateway resource.
- Type string
Resource type.
- Id string
Resource ID.
- Idle
Timeout intIn Minutes The idle timeout of the nat gateway.
- Location string
Resource location.
- Public
Ip []SubAddresses Resource Response An array of public ip addresses associated with the nat gateway resource.
- Public
Ip []SubPrefixes Resource Response An array of public ip prefixes associated with the nat gateway resource.
- Sku
Nat
Gateway Sku Response The nat gateway SKU.
- map[string]string
Resource tags.
- Zones []string
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
- etag String
A unique read-only string that changes whenever the resource is updated.
- name String
Resource name.
- provisioning
State String The provisioning state of the NAT gateway resource.
- resource
Guid String The resource GUID property of the NAT gateway resource.
- subnets
List<Sub
Resource Response> An array of references to the subnets using this nat gateway resource.
- type String
Resource type.
- id String
Resource ID.
- idle
Timeout IntegerIn Minutes The idle timeout of the nat gateway.
- location String
Resource location.
- public
Ip List<SubAddresses Resource Response> An array of public ip addresses associated with the nat gateway resource.
- public
Ip List<SubPrefixes Resource Response> An array of public ip prefixes associated with the nat gateway resource.
- sku
Nat
Gateway Sku Response The nat gateway SKU.
- Map<String,String>
Resource tags.
- zones List<String>
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
- etag string
A unique read-only string that changes whenever the resource is updated.
- name string
Resource name.
- provisioning
State string The provisioning state of the NAT gateway resource.
- resource
Guid string The resource GUID property of the NAT gateway resource.
- subnets
Sub
Resource Response[] An array of references to the subnets using this nat gateway resource.
- type string
Resource type.
- id string
Resource ID.
- idle
Timeout numberIn Minutes The idle timeout of the nat gateway.
- location string
Resource location.
- public
Ip SubAddresses Resource Response[] An array of public ip addresses associated with the nat gateway resource.
- public
Ip SubPrefixes Resource Response[] An array of public ip prefixes associated with the nat gateway resource.
- sku
Nat
Gateway Sku Response The nat gateway SKU.
- {[key: string]: string}
Resource tags.
- zones string[]
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
- etag str
A unique read-only string that changes whenever the resource is updated.
- name str
Resource name.
- provisioning_
state str The provisioning state of the NAT gateway resource.
- resource_
guid str The resource GUID property of the NAT gateway resource.
- subnets
Sequence[Sub
Resource Response] An array of references to the subnets using this nat gateway resource.
- type str
Resource type.
- id str
Resource ID.
- idle_
timeout_ intin_ minutes The idle timeout of the nat gateway.
- location str
Resource location.
- public_
ip_ Sequence[Subaddresses Resource Response] An array of public ip addresses associated with the nat gateway resource.
- public_
ip_ Sequence[Subprefixes Resource Response] An array of public ip prefixes associated with the nat gateway resource.
- sku
Nat
Gateway Sku Response The nat gateway SKU.
- Mapping[str, str]
Resource tags.
- zones Sequence[str]
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
- etag String
A unique read-only string that changes whenever the resource is updated.
- name String
Resource name.
- provisioning
State String The provisioning state of the NAT gateway resource.
- resource
Guid String The resource GUID property of the NAT gateway resource.
- subnets List<Property Map>
An array of references to the subnets using this nat gateway resource.
- type String
Resource type.
- id String
Resource ID.
- idle
Timeout NumberIn Minutes The idle timeout of the nat gateway.
- location String
Resource location.
- public
Ip List<Property Map>Addresses An array of public ip addresses associated with the nat gateway resource.
- public
Ip List<Property Map>Prefixes An array of public ip prefixes associated with the nat gateway resource.
- sku Property Map
The nat gateway SKU.
- Map<String>
Resource tags.
- zones List<String>
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
Supporting Types
NatGatewaySkuResponse
- Name string
Name of Nat Gateway SKU.
- Name string
Name of Nat Gateway SKU.
- name String
Name of Nat Gateway SKU.
- name string
Name of Nat Gateway SKU.
- name str
Name of Nat Gateway SKU.
- name String
Name of Nat Gateway SKU.
SubResourceResponse
- Id string
Resource ID.
- Id string
Resource ID.
- id String
Resource ID.
- id string
Resource ID.
- id str
Resource ID.
- id String
Resource ID.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0