Nat Gateways - Get
Gets the specified nat gateway in a specified resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2024-03-01&$expand={$expand}
Name | In | Required | Type | Description |
---|---|---|---|---|
nat
|
path | True |
string |
The name of the nat gateway. |
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client API version. |
$expand
|
query |
string |
Expands referenced resources. |
Name | Type | Description |
---|---|---|
200 OK |
Request successful. The operation returns the resulting NatGateway resource. |
|
Other Status Codes |
Error response describing why the operation failed. |
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Sample request
Sample response
{
"name": "test-natGateway",
"sku": {
"name": "Standard"
},
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
"location": "westus",
"properties": {
"idleTimeoutInMinutes": 5,
"provisioningState": "Succeeded",
"publicIpAddresses": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
}
],
"publicIpPrefixes": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
}
],
"subnets": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
}
]
},
"type": "Microsoft.Network/natGateways"
}
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Nat |
Nat Gateway resource. |
Nat |
SKU of nat gateway. |
Nat |
Name of Nat Gateway SKU. |
Provisioning |
The current provisioning state. |
Sub |
Reference to another subresource. |
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
Nat Gateway resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.idleTimeoutInMinutes |
integer |
The idle timeout of the nat gateway. |
properties.provisioningState |
The provisioning state of the NAT gateway resource. |
|
properties.publicIpAddresses |
An array of public ip addresses associated with the nat gateway resource. |
|
properties.publicIpPrefixes |
An array of public ip prefixes associated with the nat gateway resource. |
|
properties.resourceGuid |
string |
The resource GUID property of the NAT gateway resource. |
properties.subnets |
An array of references to the subnets using this nat gateway resource. |
|
sku |
The nat gateway SKU. |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
zones |
string[] |
A list of availability zones denoting the zone in which Nat Gateway should be deployed. |
SKU of nat gateway.
Name | Type | Description |
---|---|---|
name |
Name of Nat Gateway SKU. |
Name of Nat Gateway SKU.
Name | Type | Description |
---|---|---|
Standard |
string |
The current provisioning state.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
Reference to another subresource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |