Nat Gateways - Update Tags

Service:

Virtual Networks

Version d’API:

2025-09-01

Met à jour les balises nat gateway.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
natGatewayName	path	True	string	Nom de la passerelle nat.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom n’est pas sensible à la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
tags	object	Balises de ressources.

Réponses

Nom	Type	Description
200 OK	NatGateway	L’opération Azure s’est terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Usurper l’identité de votre compte utilisateur

Exemples

Update nat gateway tags

Update nat gateway with StandardV2 Sku tags

Update nat gateway tags

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2025-09-01

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Java

import com.azure.resourcemanager.network.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for NatGateways UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/NatGatewayUpdateTags.json
     */
    /**
     * Sample code: Update nat gateway tags.
     * 
     * @param manager Entry point to NetworkManager.
     */
    public static void updateNatGatewayTags(com.azure.resourcemanager.network.NetworkManager manager) {
        manager.serviceClient().getNatGateways().updateTagsWithResponse("rg1", "test-natGateway",
            new TagsObject().withTags(mapOf("tag1", "value1", "tag2", "value2")), com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python nat_gateway_update_tags.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.nat_gateways.update_tags(
        resource_group_name="rg1",
        nat_gateway_name="test-natGateway",
        parameters={"tags": {"tag1": "value1", "tag2": "value2"}},
    )
    print(response)


# x-ms-original-file: 2025-09-01/NatGatewayUpdateTags.json
if __name__ == "__main__":
    main()

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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v11"
)

// Generated from example definition: 2025-09-01/NatGatewayUpdateTags.json
func ExampleNatGatewaysClient_UpdateTags_updateNatGatewayTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNatGatewaysClient().UpdateTags(ctx, "rg1", "test-natGateway", armnetwork.TagsObject{
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetwork.NatGatewaysClientUpdateTagsResponse{
	// 	NatGateway: armnetwork.NatGateway{
	// 		Name: to.Ptr("test-natGateway"),
	// 		Type: to.Ptr("Microsoft.Network/natGateways"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway"),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armnetwork.NatGatewayPropertiesFormat{
	// 			IdleTimeoutInMinutes: to.Ptr[int32](5),
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			PublicIPAddresses: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
	// 				},
	// 			},
	// 			PublicIPPrefixes: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
	// 				},
	// 			},
	// 			Subnets: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"),
	// 				},
	// 			},
	// 		},
	// 		SKU: &armnetwork.NatGatewaySKU{
	// 			Name: to.Ptr(armnetwork.NatGatewaySKUNameStandard),
	// 		},
	// 		Tags: map[string]*string{
	// 			"tag1": to.Ptr("value1"),
	// 			"tag2": to.Ptr("value2"),
	// 		},
	// 	},
	// }
}

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates nat gateway tags.
 *
 * @summary updates nat gateway tags.
 * x-ms-original-file: 2025-09-01/NatGatewayUpdateTags.json
 */
async function updateNatGatewayTags() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.natGateways.updateTags("rg1", "test-natGateway", {
    tags: { tag1: "value1", tag2: "value2" },
  });
  console.log(result);
}

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

Exemple de réponse

Code d’état:

200

{
  "name": "test-natGateway",
  "type": "Microsoft.Network/natGateways",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
  "location": "westus",
  "properties": {
    "idleTimeoutInMinutes": 5,
    "provisioningState": "Succeeded",
    "publicIpAddresses": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
      }
    ],
    "subnets": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
      }
    ]
  },
  "sku": {
    "name": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Update nat gateway with StandardV2 Sku tags

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2025-09-01

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Java

import com.azure.resourcemanager.network.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for NatGateways UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/NatGatewayUpdateTagsStandardV2Sku.json
     */
    /**
     * Sample code: Update nat gateway with StandardV2 Sku tags.
     * 
     * @param manager Entry point to NetworkManager.
     */
    public static void updateNatGatewayWithStandardV2SkuTags(com.azure.resourcemanager.network.NetworkManager manager) {
        manager.serviceClient().getNatGateways().updateTagsWithResponse("rg1", "test-natGateway",
            new TagsObject().withTags(mapOf("tag1", "value1", "tag2", "value2")), com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python nat_gateway_update_tags_standard_v2_sku.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.nat_gateways.update_tags(
        resource_group_name="rg1",
        nat_gateway_name="test-natGateway",
        parameters={"tags": {"tag1": "value1", "tag2": "value2"}},
    )
    print(response)


# x-ms-original-file: 2025-09-01/NatGatewayUpdateTagsStandardV2Sku.json
if __name__ == "__main__":
    main()

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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v11"
)

// Generated from example definition: 2025-09-01/NatGatewayUpdateTagsStandardV2Sku.json
func ExampleNatGatewaysClient_UpdateTags_updateNatGatewayWithStandardV2SkuTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNatGatewaysClient().UpdateTags(ctx, "rg1", "test-natGateway", armnetwork.TagsObject{
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetwork.NatGatewaysClientUpdateTagsResponse{
	// 	NatGateway: armnetwork.NatGateway{
	// 		Name: to.Ptr("test-natGateway"),
	// 		Type: to.Ptr("Microsoft.Network/natGateways"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway"),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armnetwork.NatGatewayPropertiesFormat{
	// 			IdleTimeoutInMinutes: to.Ptr[int32](5),
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			PublicIPAddresses: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
	// 				},
	// 			},
	// 			PublicIPAddressesV6: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2"),
	// 				},
	// 			},
	// 			PublicIPPrefixes: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
	// 				},
	// 			},
	// 			PublicIPPrefixesV6: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2"),
	// 				},
	// 			},
	// 			SourceVirtualNetwork: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet"),
	// 			},
	// 			Subnets: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"),
	// 				},
	// 			},
	// 		},
	// 		SKU: &armnetwork.NatGatewaySKU{
	// 			Name: to.Ptr(armnetwork.NatGatewaySKUNameStandardV2),
	// 		},
	// 		Tags: map[string]*string{
	// 			"tag1": to.Ptr("value1"),
	// 			"tag2": to.Ptr("value2"),
	// 		},
	// 	},
	// }
}

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates nat gateway tags.
 *
 * @summary updates nat gateway tags.
 * x-ms-original-file: 2025-09-01/NatGatewayUpdateTagsStandardV2Sku.json
 */
async function updateNatGatewayWithStandardV2SkuTags() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.natGateways.updateTags("rg1", "test-natGateway", {
    tags: { tag1: "value1", tag2: "value2" },
  });
  console.log(result);
}

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

Exemple de réponse

Code d’état:

200

{
  "name": "test-natGateway",
  "type": "Microsoft.Network/natGateways",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
  "location": "westus",
  "properties": {
    "idleTimeoutInMinutes": 5,
    "provisioningState": "Succeeded",
    "publicIpAddresses": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
      }
    ],
    "publicIpAddressesV6": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
      }
    ],
    "publicIpPrefixesV6": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2"
      }
    ],
    "sourceVirtualNetwork": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet"
    },
    "subnets": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
      }
    ]
  },
  "sku": {
    "name": "StandardV2"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
Nat64State	Est-ce que Nat64 est activé pour la ressource NAT Gateway ?
NatGateway	Ressource nat Gateway.
NatGatewaySku	Référence SKU de la passerelle nat.
NatGatewaySkuName	Nom de la référence SKU nat Gateway.
ProvisioningState	États de provisionnement d’une ressource.
SubResource	Référence à une autre sous-ressource.
TagsObject	Objet Balises pour les opérations de correctif.

CloudError

Objet

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur Cloud.

CloudErrorBody

Objet

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

Nat64State

Énumération

Est-ce que Nat64 est activé pour la ressource NAT Gateway ?

Valeur	Description
None	La propriété Nat64 n’est pas définie.
Enabled	Nat64 est activé.
Disabled	Nat64 est désactivé.

NatGateway

Objet

Ressource nat Gateway.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de la ressource
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.idleTimeoutInMinutes	integer (int32)	Délai d’inactivité de la passerelle nat.
properties.nat64	Nat64State	Est-ce que Nat64 est activé pour la ressource NAT Gateway ?
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de passerelle NAT.
properties.publicIpAddresses	SubResource[]	Tableau d’adresses IP publiques V4 associées à la ressource de passerelle nat.
properties.publicIpAddressesV6	SubResource[]	Tableau d’adresses IP publiques V6 associées à la ressource de passerelle nat.
properties.publicIpPrefixes	SubResource[]	Tableau de préfixes d’adresse IP publique V4 associés à la ressource de passerelle nat.
properties.publicIpPrefixesV6	SubResource[]	Tableau de préfixes d’adresse IP publique V6 associés à la ressource de passerelle nat.
properties.resourceGuid	string	Propriété GUID de ressource de la ressource de passerelle NAT.
properties.serviceGateway	SubResource	Référence à une passerelle de service existante.
properties.sourceVirtualNetwork	SubResource	Référence au réseau virtuel source à l’aide de cette ressource de passerelle nat.
properties.subnets	SubResource[]	Tableau de références aux sous-réseaux à l’aide de cette ressource de passerelle nat.
sku	NatGatewaySku	Référence SKU de passerelle nat.
tags	object	Balises de ressources.
type	string	Type de ressource.
zones	string[]	Liste des zones de disponibilité indiquant la zone dans laquelle la passerelle Nat doit être déployée.

NatGatewaySku

Objet

Référence SKU de la passerelle nat.

Nom	Type	Description
name	NatGatewaySkuName	Nom de la référence SKU nat Gateway.

NatGatewaySkuName

Énumération

Nom de la référence SKU nat Gateway.

Valeur	Description
Standard	Standard
StandardV2	StandardV2

ProvisioningState

Énumération

États de provisionnement d’une ressource.

Valeur	Description
Failed	Échec
Succeeded	Réussi
Canceled	Opération annulée
Creating	Création
Updating	Updating
Deleting	Suppression

SubResource

Objet

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de la ressource

TagsObject

Objet

Objet Balises pour les opérations de correctif.

Nom	Type	Description
tags	object	Balises de ressources.