Devices - Update Tags

Service:

Hybrid Network

API-versie:

2021-05-01

Hiermee worden apparaattags bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
deviceName	path	True	string	De naam van de apparaatresource.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
tags	object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	Device	De update is voltooid. De bewerking retourneert de resulterende apparaatresource.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update hybrid network device tags

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
Device	Apparaatresource.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ProvisioningState	De huidige inrichtingsstatus.
Status	De huidige apparaatstatus.
SubResource	Verwijzing naar een andere subresource.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TagsObject	Tagsobject voor patchbewerkingen.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

Device

Object

Apparaatresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.deviceType	DeviceType	Het type apparaat.
properties.networkFunctions	SubResource[]	De lijst met netwerkfuncties die op het apparaat zijn geïmplementeerd.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de apparaatresource.
properties.status	Status	De huidige apparaatstatus.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Accepted
Canceled
Deleted
Deleting
Failed
Succeeded
Unknown

Status

Inventarisatie

De huidige apparaatstatus.

Waarde	Description
Deleted
NotRegistered
Registered
Unknown

SubResource

Object

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TagsObject

Object

Tagsobject voor patchbewerkingen.

Name	Type	Description
tags	object	Resourcetags.