Custom IP Prefixes - Update Tags

Service:

Virtual Networks

API Version:

2023-09-01

사용자 지정 IP 접두사 태그를 업데이트.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
customIpPrefixName	path	True	string	사용자 지정 IP 접두사 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	형식	Description
tags	object	리소스 태그.

응답

Name	형식	Description
200 OK	CustomIpPrefix	업데이트에 성공했습니다. 작업은 결과 customIpPrefix 리소스를 반환합니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

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

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
CommissionedState	사용자 지정 IP 접두사의 위임된 상태입니다.
CustomIpPrefix	사용자 지정 IP 접두사 리소스.
CustomIpPrefixType	사용자 지정 IP 접두사 유형입니다. 단수, 부모 또는 자식이어야 합니다.
ExtendedLocation	ExtendedLocation 복합 형식입니다.
ExtendedLocationTypes	확장된 위치의 형식입니다.
Geo	CIDR 광고를 위한 지역입니다. 지역 코드여야 합니다.
ProvisioningState	현재 프로비저닝 상태입니다.
SubResource	다른 하위 리소스에 대한 참조입니다.
TagsObject	패치 작업에 대한 태그 개체입니다.

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	클라우드 오류 본문.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

CommissionedState

사용자 지정 IP 접두사의 위임된 상태입니다.

Name	형식	Description
Commissioned	string
CommissionedNoInternetAdvertise	string
Commissioning	string
Decommissioning	string
Deprovisioned	string
Deprovisioning	string
Provisioned	string
Provisioning	string

CustomIpPrefix

사용자 지정 IP 접두사 리소스.

Name	형식	Description
etag	string	리소스를 업데이트할 때마다 변경되는 고유한 읽기 전용 문자열입니다.
extendedLocation	ExtendedLocation	사용자 지정 IP 접두사 확장 위치입니다.
id	string	리소스 ID입니다.
location	string	리소스 위치.
name	string	리소스 이름입니다.
properties.asn	string	CIDR 광고용 ASN입니다. 문자열로 정수여야 합니다.
properties.authorizationMessage	string	WAN 유효성 검사에 대한 권한 부여 메시지입니다.
properties.childCustomIpPrefixes	SubResource[]	IPv6 /48 CustomIpPrefix에 대한 모든 자식 목록입니다.
properties.cidr	string	CIDR 표기법의 접두사 범위입니다. 시작 주소와 접두사 길이를 포함해야 합니다.
properties.commissionedState	CommissionedState	사용자 지정 IP 접두사의 위임된 상태입니다.
properties.customIpPrefixParent	SubResource	IPv6 /64 CustomIpPrefix에 대한 부모 CustomIpPrefix입니다.
properties.expressRouteAdvertise	boolean	빠른 경로 광고를 수행할지 여부입니다.
properties.failedReason	string	리소스가 실패 상태인 이유입니다.
properties.geo	Geo	CIDR 광고를 위한 지역입니다. 지역 코드여야 합니다.
properties.noInternetAdvertise	boolean	인터넷에 범위를 보급할지 여부입니다.
properties.prefixType	CustomIpPrefixType	사용자 지정 IP 접두사 유형입니다. 단수, 부모 또는 자식이어야 합니다.
properties.provisioningState	ProvisioningState	사용자 지정 IP 접두사 리소스의 프로비전 상태입니다.
properties.publicIpPrefixes	SubResource[]	참조된 모든 PublicIpPrefixes 목록입니다.
properties.resourceGuid	string	사용자 지정 IP 접두사 리소스의 리소스 GUID 속성입니다.
properties.signedMessage	string	WAN 유효성 검사를 위해 서명된 메시지입니다.
tags	object	리소스 태그.
type	string	리소스 종류.
zones	string[]	리소스에 할당된 IP를 나타내는 가용성 영역의 목록입니다.

CustomIpPrefixType

사용자 지정 IP 접두사 유형입니다. 단수, 부모 또는 자식이어야 합니다.

Name	형식	Description
Child	string
Parent	string
Singular	string

ExtendedLocation

ExtendedLocation 복합 형식입니다.

Name	형식	Description
name	string	확장된 위치의 이름입니다.
type	ExtendedLocationTypes	확장된 위치의 형식입니다.

ExtendedLocationTypes

확장된 위치의 형식입니다.

Name	형식	Description
EdgeZone	string

Geo

CIDR 광고를 위한 지역입니다. 지역 코드여야 합니다.

Name	형식	Description
AFRI	string
APAC	string
AQ	string
EURO	string
GLOBAL	string
LATAM	string
ME	string
NAM	string
OCEANIA	string

ProvisioningState

현재 프로비저닝 상태입니다.

Name	형식	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

다른 하위 리소스에 대한 참조입니다.

Name	형식	Description
id	string	리소스 ID입니다.

TagsObject

패치 작업에 대한 태그 개체입니다.

Name	형식	Description
tags	object	리소스 태그.