Custom IP Prefixes - Update Tags

Service:

Virtual Networks

API Version:

2023-09-01

Aktualizacje niestandardowych tagów prefiksów adresów IP.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
customIpPrefixName	path	True	string	Nazwa niestandardowego prefiksu adresu IP.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CustomIpPrefix	Aktualizacja powiodła się. Operacja zwraca wynikowy zasób customIpPrefix.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Update public IP address tags

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix?api-version=2023-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 CustomIpPrefixes UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/CustomIpPrefixUpdateTags.json
     */
    /**
     * Sample code: Update public IP address tags.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatePublicIPAddressTags(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getCustomIpPrefixes().updateTagsWithResponse("rg1",
            "test-customipprefix", 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 custom_ip_prefix_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.custom_ip_prefixes.update_tags(
        resource_group_name="rg1",
        custom_ip_prefix_name="test-customipprefix",
        parameters={"tags": {"tag1": "value1", "tag2": "value2"}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/CustomIpPrefixUpdateTags.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/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/CustomIpPrefixUpdateTags.json
func ExampleCustomIPPrefixesClient_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.NewCustomIPPrefixesClient().UpdateTags(ctx, "rg1", "test-customipprefix", 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.CustomIPPrefix = armnetwork.CustomIPPrefix{
	// 	Name: to.Ptr("test-customipprefix"),
	// 	Type: to.Ptr("Microsoft.Network/customIpPrefixes"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-00000000\""),
	// 	Properties: &armnetwork.CustomIPPrefixPropertiesFormat{
	// 		AuthorizationMessage: to.Ptr("authorizationMessage"),
	// 		ChildCustomIPPrefixes: []*armnetwork.SubResource{
	// 		},
	// 		Cidr: to.Ptr("192.168.254.2/24"),
	// 		CommissionedState: to.Ptr(armnetwork.CommissionedStateProvisioning),
	// 		FailedReason: to.Ptr(""),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPPrefixes: []*armnetwork.SubResource{
	// 		},
	// 		ResourceGUID: to.Ptr("00000000-0000-0000-0000-00000000"),
	// 		SignedMessage: to.Ptr("signedMessage"),
	// 	},
	// 	Zones: []*string{
	// 		to.Ptr("1")},
	// 	}
}

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 custom IP prefix tags.
 *
 * @summary Updates custom IP prefix tags.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/CustomIpPrefixUpdateTags.json
 */
async function updatePublicIPAddressTags() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const customIpPrefixName = "test-customipprefix";
  const parameters = { tags: { tag1: "value1", tag2: "value2" } };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.customIPPrefixes.updateTags(
    resourceGroupName,
    customIpPrefixName,
    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

dotnet

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/CustomIpPrefixUpdateTags.json
// this example is just showing the usage of "CustomIPPrefixes_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 CustomIPPrefixResource created on azure
// for more information of creating CustomIPPrefixResource, please refer to the document of CustomIPPrefixResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string customIPPrefixName = "test-customipprefix";
ResourceIdentifier customIPPrefixResourceId = CustomIPPrefixResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, customIPPrefixName);
CustomIPPrefixResource customIPPrefix = client.GetCustomIPPrefixResource(customIPPrefixResourceId);

// invoke the operation
NetworkTagsObject networkTagsObject = new NetworkTagsObject()
{
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
CustomIPPrefixResource result = await customIPPrefix.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
CustomIPPrefixData 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-customipprefix",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "westus",
  "zones": [
    "1"
  ],
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "cidr": "192.168.254.2/24",
    "commissionedState": "Provisioning",
    "signedMessage": "signedMessage",
    "authorizationMessage": "authorizationMessage",
    "failedReason": "",
    "publicIpPrefixes": [],
    "childCustomIpPrefixes": []
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.Network/customIpPrefixes"
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
CommissionedState	Stan zlecony niestandardowego prefiksu adresu IP.
CustomIpPrefix	Zasób niestandardowego prefiksu ADRESU IP.
CustomIpPrefixType	Typ niestandardowego prefiksu adresu IP. Powinna być pojedyncza, nadrzędna lub podrzędna.
ExtendedLocation	Typ złożony ExtendedLocation.
ExtendedLocationTypes	Typ lokalizacji rozszerzonej.
Geo	Geo for CIDR advertising (Geo for CIDR advertising). Powinien być kodem geograficznym.
ProvisioningState	Bieżący stan aprowizacji.
SubResource	Odwołanie do innego podźródła.
TagsObject	Obiekt tagów dla operacji poprawek.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

CommissionedState

Stan zlecony niestandardowego prefiksu adresu IP.

Nazwa	Typ	Opis
Commissioned	string
CommissionedNoInternetAdvertise	string
Commissioning	string
Decommissioning	string
Deprovisioned	string
Deprovisioning	string
Provisioned	string
Provisioning	string

CustomIpPrefix

Zasób niestandardowego prefiksu ADRESU IP.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
extendedLocation	ExtendedLocation	Rozszerzona lokalizacja niestandardowego prefiksu adresu IP.
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.asn	string	AsN do reklamy CIDR. Powinna być liczbą całkowitą jako ciągiem.
properties.authorizationMessage	string	Komunikat autoryzacji na potrzeby weryfikacji sieci WAN.
properties.childCustomIpPrefixes	SubResource[]	Lista wszystkich elementów podrzędnych dla IPv6 /48 CustomIpPrefix.
properties.cidr	string	Zakres prefiksów w notacji CIDR. Powinien zawierać adres początkowy i długość prefiksu.
properties.commissionedState	CommissionedState	Stan zlecony niestandardowego prefiksu adresu IP.
properties.customIpPrefixParent	SubResource	Nadrzędny prefiks CustomIpPrefix dla IPv6 /64 CustomIpPrefix.
properties.expressRouteAdvertise	boolean	Czy anonsować usługę Express Route.
properties.failedReason	string	Powód, dla którego zasób jest w stanie niepowodzenia.
properties.geo	Geo	Geo for CIDR advertising (Geo for CIDR advertising). Powinien być kodem geograficznym.
properties.noInternetAdvertise	boolean	Czy reklamować zakres do Internetu.
properties.prefixType	CustomIpPrefixType	Typ niestandardowego prefiksu adresu IP. Powinna być pojedyncza, nadrzędna lub podrzędna.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu niestandardowego prefiksu IP.
properties.publicIpPrefixes	SubResource[]	Lista wszystkich odwołanych prefiksów PublicIpPrefixes.
properties.resourceGuid	string	Właściwość identyfikatora GUID zasobu niestandardowego prefiksu ADRESU IP.
properties.signedMessage	string	Podpisany komunikat dotyczący weryfikacji sieci WAN.
tags	object	Tagi zasobów.
type	string	Typ zasobu.
zones	string[]	Lista stref dostępności oznaczających adres IP przydzielony dla zasobu musi pochodzić.

CustomIpPrefixType

Typ niestandardowego prefiksu adresu IP. Powinna być pojedyncza, nadrzędna lub podrzędna.

Nazwa	Typ	Opis
Child	string
Parent	string
Singular	string

ExtendedLocation

Typ złożony ExtendedLocation.

Nazwa	Typ	Opis
name	string	Nazwa lokalizacji rozszerzonej.
type	ExtendedLocationTypes	Typ lokalizacji rozszerzonej.

ExtendedLocationTypes

Typ lokalizacji rozszerzonej.

Nazwa	Typ	Opis
EdgeZone	string

Geo

Geo for CIDR advertising (Geo for CIDR advertising). Powinien być kodem geograficznym.

Nazwa	Typ	Opis
AFRI	string
APAC	string
AQ	string
EURO	string
GLOBAL	string
LATAM	string
ME	string
NAM	string
OCEANIA	string

ProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Odwołanie do innego podźródła.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

TagsObject

Obiekt tagów dla operacji poprawek.

Nazwa	Typ	Opis
tags	object	Tagi zasobów.