Devices - Update Tags

서비스:

Hybrid Network

API 버전:

2021-05-01

디바이스 태그를 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/devices/{deviceName}?api-version=2021-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
deviceName	path	True	string	디바이스 리소스의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

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

응답

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

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Update hybrid network device tags

샘플 요청

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice?api-version=2021-05-01

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.hybridnetwork.models.Device;
import java.util.HashMap;
import java.util.Map;

/** Samples for Devices UpdateTags. */
public final class Main {
    /*
     * x-ms-original-file: specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceUpdateTags.json
     */
    /**
     * Sample code: Update hybrid network device tags.
     *
     * @param manager Entry point to HybridNetworkManager.
     */
    public static void updateHybridNetworkDeviceTags(
        com.azure.resourcemanager.hybridnetwork.HybridNetworkManager manager) {
        Device resource =
            manager.devices().getByResourceGroupWithResponse("rg1", "TestDevice", Context.NONE).getValue();
        resource.update().withTags(mapOf("tag1", "value1", "tag2", "value2")).apply();
    }

    @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

Go

package armhybridnetwork_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/hybridnetwork/armhybridnetwork"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceUpdateTags.json
func ExampleDevicesClient_UpdateTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().UpdateTags(ctx, "rg1", "TestDevice", armhybridnetwork.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.Device = armhybridnetwork.Device{
	// 	Name: to.Ptr("TestDevice"),
	// 	Type: to.Ptr("Microsoft.HybridNetwork/devices"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armhybridnetwork.AzureStackEdgeFormat{
	// 		DeviceType: to.Ptr(armhybridnetwork.DeviceTypeAzureStackEdge),
	// 		NetworkFunctions: []*armhybridnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/TestNetworkFunction"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 		Status: to.Ptr(armhybridnetwork.StatusNotRegistered),
	// 		AzureStackEdge: &armhybridnetwork.SubResource{
	// 			ID: to.Ptr("/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName"),
	// 		},
	// 	},
	// }
}

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

샘플 응답

상태 코드:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice",
  "name": "TestDevice",
  "type": "Microsoft.HybridNetwork/devices",
  "location": "eastus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "status": "NotRegistered",
    "provisioningState": "Succeeded",
    "deviceType": "AzureStackEdge",
    "azureStackEdge": {
      "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName"
    },
    "networkFunctions": [
      {
        "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/TestNetworkFunction"
      }
    ]
  }
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
Device	디바이스 리소스.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ProvisioningState	현재 프로비저닝 상태입니다.
Status	현재 디바이스 상태입니다.
SubResource	다른 하위 리소스에 대한 참조입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
TagsObject	패치 작업에 대한 태그 개체입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

Device

Object

디바이스 리소스.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties.deviceType	DeviceType	디바이스의 유형입니다.
properties.networkFunctions	SubResource[]	디바이스에 배포된 네트워크 함수 목록입니다.
properties.provisioningState	ProvisioningState	디바이스 리소스의 프로비전 상태입니다.
properties.status	Status	현재 디바이스 상태입니다.
systemData	systemData	이 리소스와 관련된 시스템 메타 데이터입니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

ProvisioningState

열거형

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

값	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted

Status

열거형

현재 디바이스 상태입니다.

값	Description
Unknown
NotRegistered
Registered
Deleted

SubResource

Object

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

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

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

TagsObject

Object

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

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