Nat Gateways - Create Or Update

Service:: Virtual Networks

API Version:: 2025-01-01

Creates or updates a nat gateway.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2025-01-01

URI Parameters

Name	In	Required	Type	Description
natGatewayName	path	True	string	The name of the nat gateway.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	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.

Request Body

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
properties.idleTimeoutInMinutes	integer (int32)	The idle timeout of the nat gateway.
properties.publicIpAddresses	SubResource[]	An array of public ip addresses V4 associated with the nat gateway resource.
properties.publicIpAddressesV6	SubResource[]	An array of public ip addresses V6 associated with the nat gateway resource.
properties.publicIpPrefixes	SubResource[]	An array of public ip prefixes V4 associated with the nat gateway resource.
properties.publicIpPrefixesV6	SubResource[]	An array of public ip prefixes V6 associated with the nat gateway resource.
properties.sourceVirtualNetwork	SubResource	A reference to the source virtual network using this nat gateway resource.
sku	NatGatewaySku	The nat gateway SKU.
tags	object	Resource tags.
zones	string[]	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

Responses

Name	Type	Description
200 OK	NatGateway	Update successful. The operation returns the resulting NatGateway resource.
201 Created	NatGateway	Create successful. The operation returns the resulting NatGateway resource.
202 Accepted		Accepted and the operation will complete asynchronously.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create nat gateway

Create nat gateway with StandardV2 Sku

Create nat gateway

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natgateway?api-version=2025-01-01

{
  "location": "westus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "publicIpAddresses": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
      }
    ]
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2025-01-01/examples/NatGatewayCreateOrUpdate.json
// this example is just showing the usage of "NatGateways_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NatGatewayResource
NatGatewayCollection collection = resourceGroupResource.GetNatGateways();

// invoke the operation
string natGatewayName = "test-natgateway";
NatGatewayData data = new NatGatewayData
{
    SkuName = NatGatewaySkuName.Standard,
    PublicIPAddresses = {new WritableSubResource
    {
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
    }},
    PublicIPPrefixes = {new WritableSubResource
    {
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
    }},
    Location = new AzureLocation("westus"),
};
ArmOperation<NatGatewayResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, natGatewayName, data);
NatGatewayResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NatGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

Create nat gateway with StandardV2 Sku

Sample request

HTTP
dotnet

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natgateway?api-version=2025-01-01

{
  "location": "westus",
  "sku": {
    "name": "StandardV2"
  },
  "properties": {
    "publicIpAddresses": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
      }
    ]
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2025-01-01/examples/NatGatewayCreateOrUpdateStandardV2Sku.json
// this example is just showing the usage of "NatGateways_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NatGatewayResource
NatGatewayCollection collection = resourceGroupResource.GetNatGateways();

// invoke the operation
string natGatewayName = "test-natgateway";
NatGatewayData data = new NatGatewayData
{
    SkuName = NatGatewaySkuName.StandardV2,
    PublicIPAddresses = {new WritableSubResource
    {
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
    }},
    PublicIPPrefixes = {new WritableSubResource
    {
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
    }},
    Location = new AzureLocation("westus"),
};
ArmOperation<NatGatewayResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, natGatewayName, data);
NatGatewayResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NatGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "test-natGateway",
  "sku": {
    "name": "StandardV2"
  },
  "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"
      }
    ],
    "sourceVirtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet"
    }
  },
  "type": "Microsoft.Network/natGateways"
}

Status code:: 201

{
  "name": "test-natGateway",
  "sku": {
    "name": "StandardV2"
  },
  "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"
      }
    ],
    "publicIpAddressesV6": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2"
      }
    ],
    "publicIpPrefixesV6": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2"
      }
    ],
    "subnets": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
      }
    ],
    "sourceVirtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet"
    }
  },
  "type": "Microsoft.Network/natGateways"
}

Status code:: 202

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
NatGateway	Nat Gateway resource.
NatGatewaySku	SKU of nat gateway.
NatGatewaySkuName	Name of Nat Gateway SKU.
ProvisioningState	The current provisioning state.
SubResource	Reference to another subresource.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

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	CloudErrorBody[]	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.

NatGateway

Object

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 (int32)	The idle timeout of the nat gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the NAT gateway resource.
properties.publicIpAddresses	SubResource[]	An array of public ip addresses V4 associated with the nat gateway resource.
properties.publicIpAddressesV6	SubResource[]	An array of public ip addresses V6 associated with the nat gateway resource.
properties.publicIpPrefixes	SubResource[]	An array of public ip prefixes V4 associated with the nat gateway resource.
properties.publicIpPrefixesV6	SubResource[]	An array of public ip prefixes V6 associated with the nat gateway resource.
properties.resourceGuid	string	The resource GUID property of the NAT gateway resource.
properties.sourceVirtualNetwork	SubResource	A reference to the source virtual network using this nat gateway resource.
properties.subnets	SubResource[]	An array of references to the subnets using this nat gateway resource.
sku	NatGatewaySku	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.

NatGatewaySku

Object

SKU of nat gateway.

Name	Type	Description
name	NatGatewaySkuName	Name of Nat Gateway SKU.

NatGatewaySkuName

Enumeration

Name of Nat Gateway SKU.

Value	Description
Standard
StandardV2

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Succeeded
Updating
Deleting
Failed

SubResource

Object

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

Share via

Nat Gateways - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create nat gateway

Sample request

Sample response

Create nat gateway with StandardV2 Sku

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

NatGateway

NatGatewaySku

NatGatewaySkuName

ProvisioningState

SubResource