Nat Gateways - Update Tags

Referentie

Service:: Virtual Networks

API Version:: 2023-09-01

Updates nat-gatewaytags.

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

URI-parameters

Name	In	Vereist	Type	Description
natGatewayName	path	True	string	De naam van de nat-gateway.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
tags	object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	NatGateway	De update is voltooid. De bewerking retourneert de resulterende NatGateway-resource.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Update nat gateway tags

Sample Request

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

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


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:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayUpdateTags.json
     */
    /**
     * Sample code: Update nat gateway tags.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateNatGatewayTags(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().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

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="subid",
    )

    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: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayUpdateTags.json
func ExampleNatGatewaysClient_UpdateTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", 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.NatGateway = armnetwork.NatGateway{
	// 	Name: to.Ptr("test-natGateway"),
	// 	Type: to.Ptr("Microsoft.Network/natGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armnetwork.NatGatewayPropertiesFormat{
	// 		IdleTimeoutInMinutes: to.Ptr[int32](5),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPAddresses: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
	// 		}},
	// 		PublicIPPrefixes: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
	// 		}},
	// 		Subnets: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"),
	// 		}},
	// 	},
	// 	SKU: &armnetwork.NatGatewaySKU{
	// 		Name: to.Ptr(armnetwork.NatGatewaySKUNameStandard),
	// 	},
	// }
}

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

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: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayUpdateTags.json
 */
async function updateNatGatewayTags() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const natGatewayName = "test-natGateway";
  const parameters = { tags: { tag1: "value1", tag2: "value2" } };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.natGateways.updateTags(resourceGroupName, natGatewayName, parameters);
  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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayUpdateTags.json
// this example is just showing the usage of "NatGateways_UpdateTags" 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://learn.microsoft.com/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 NatGatewayResource created on azure
// for more information of creating NatGatewayResource, please refer to the document of NatGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string natGatewayName = "test-natGateway";
ResourceIdentifier natGatewayResourceId = NatGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, natGatewayName);
NatGatewayResource natGateway = client.GetNatGatewayResource(natGatewayResourceId);

// invoke the operation
NetworkTagsObject networkTagsObject = new NetworkTagsObject()
{
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
NatGatewayResource result = await natGateway.UpdateAsync(networkTagsObject);

// 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"
      }
    ]
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.Network/natGateways"
}

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
NatGateway	Nat Gateway-resource.
NatGatewaySku	SKU van nat-gateway.
NatGatewaySkuName	Naam van nat-gateway-SKU.
ProvisioningState	De huidige inrichtingsstatus.
SubResource	Verwijzing naar een andere subresource.
TagsObject	Tagsobject voor patchbewerkingen.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

NatGateway

Nat Gateway-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.idleTimeoutInMinutes	integer	De time-out voor inactiviteit van de NAT-gateway.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de NAT-gatewayresource.
properties.publicIpAddresses	SubResource[]	Een matrix van openbare IP-adressen die zijn gekoppeld aan de nat-gatewayresource.
properties.publicIpPrefixes	SubResource[]	Een matrix van openbare IP-voorvoegsels die zijn gekoppeld aan de nat-gatewayresource.
properties.resourceGuid	string	De resource-GUID-eigenschap van de NAT-gatewayresource.
properties.subnets	SubResource[]	Een matrix met verwijzingen naar de subnetten met behulp van deze NAT-gatewayresource.
sku	NatGatewaySku	De nat-gateway-SKU.
tags	object	Resourcetags.
type	string	Resourcetype.
zones	string[]	Een lijst met beschikbaarheidszones die de zone aangeeft waarin Nat Gateway moet worden geïmplementeerd.

NatGatewaySku

SKU van nat-gateway.

Name	Type	Description
name	NatGatewaySkuName	Naam van nat-gateway-SKU.

NatGatewaySkuName

Naam van nat-gateway-SKU.

Name	Type	Description
Standard	string

ProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

TagsObject

Tagsobject voor patchbewerkingen.

Name	Type	Description
tags	object	Resourcetags.