Instances - Update

Servicio:

Device Update

Versión de la API:

2023-07-01

Actualiza las etiquetas de la instancia.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances/{instanceName}?api-version=2023-07-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Nombre de cuenta.
instanceName	path	True	string minLength: 3 maxLength: 36 pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Nombre de instancia.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de suscripción de Azure.
api-version	query	True	string	Versión de la API de esquema de ADU.

Cuerpo de la solicitud

Nombre	Tipo	Description
tags	object	Lista de pares clave-valor que describen el recurso. Esto sobrescribirá las etiquetas existentes.

Respuestas

Nombre	Tipo	Description
200 OK	Instance	Instancia actualizada correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar la cuenta de usuario

Ejemplos

Updates Instance

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue?api-version=2023-07-01

{
  "tags": {
    "tagKey": "tagValue"
  }
}

Java

import com.azure.resourcemanager.deviceupdate.models.Instance;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Instances Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Instances/
     * Instances_Update.json
     */
    /**
     * Sample code: Updates Instance.
     * 
     * @param manager Entry point to DeviceUpdateManager.
     */
    public static void updatesInstance(com.azure.resourcemanager.deviceupdate.DeviceUpdateManager manager) {
        Instance resource = manager.instances()
            .getWithResponse("test-rg", "contoso", "blue", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("tagKey", "fakeTokenPlaceholder")).apply();
    }

    // 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.deviceupdate import DeviceUpdateMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-deviceupdate
# USAGE
    python instances_update.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 = DeviceUpdateMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.instances.update(
        resource_group_name="test-rg",
        account_name="contoso",
        instance_name="blue",
        tag_update_payload={"tags": {"tagKey": "tagValue"}},
    )
    print(response)


# x-ms-original-file: specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Instances/Instances_Update.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 armdeviceupdate_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/deviceupdate/armdeviceupdate"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8c74fd80b415fa1ebb6fa787d454694c39e0fd5/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Instances/Instances_Update.json
func ExampleInstancesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeviceupdate.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInstancesClient().Update(ctx, "test-rg", "contoso", "blue", armdeviceupdate.TagUpdate{
		Tags: map[string]*string{
			"tagKey": to.Ptr("tagValue"),
		},
	}, 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.Instance = armdeviceupdate.Instance{
	// 	Name: to.Ptr("blue"),
	// 	Type: to.Ptr("Microsoft.DeviceUpdate/accounts/instances"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue"),
	// 	Location: to.Ptr("westus2"),
	// 	Tags: map[string]*string{
	// 		"tagKey": to.Ptr("tagValue"),
	// 	},
	// 	Properties: &armdeviceupdate.InstanceProperties{
	// 		AccountName: to.Ptr("contoso"),
	// 		DiagnosticStorageProperties: &armdeviceupdate.DiagnosticStorageProperties{
	// 			AuthenticationType: to.Ptr(armdeviceupdate.AuthenticationTypeKeyBased),
	// 			ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"),
	// 		},
	// 		EnableDiagnostics: to.Ptr(false),
	// 		IotHubs: []*armdeviceupdate.IotHubSettings{
	// 			{
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"),
	// 		}},
	// 	},
	// }
}

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 { DeviceUpdate } = require("@azure/arm-deviceupdate");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates instance's tags.
 *
 * @summary Updates instance's tags.
 * x-ms-original-file: specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Instances/Instances_Update.json
 */
async function updatesInstance() {
  const subscriptionId =
    process.env["DEVICEUPDATE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["DEVICEUPDATE_RESOURCE_GROUP"] || "test-rg";
  const accountName = "contoso";
  const instanceName = "blue";
  const tagUpdatePayload = { tags: { tagKey: "tagValue" } };
  const credential = new DefaultAzureCredential();
  const client = new DeviceUpdate(credential, subscriptionId);
  const result = await client.instances.update(
    resourceGroupName,
    accountName,
    instanceName,
    tagUpdatePayload,
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DeviceUpdate.Models;
using Azure.ResourceManager.DeviceUpdate;

// Generated from example definition: specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Instances/Instances_Update.json
// this example is just showing the usage of "Instances_Update" 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 DeviceUpdateInstanceResource created on azure
// for more information of creating DeviceUpdateInstanceResource, please refer to the document of DeviceUpdateInstanceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "test-rg";
string accountName = "contoso";
string instanceName = "blue";
ResourceIdentifier deviceUpdateInstanceResourceId = DeviceUpdateInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, instanceName);
DeviceUpdateInstanceResource deviceUpdateInstance = client.GetDeviceUpdateInstanceResource(deviceUpdateInstanceResourceId);

// invoke the operation
DeviceUpdateInstancePatch patch = new DeviceUpdateInstancePatch
{
    Tags =
    {
    ["tagKey"] = "tagValue"
    },
};
DeviceUpdateInstanceResource result = await deviceUpdateInstance.UpdateAsync(patch);

// 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
DeviceUpdateInstanceData 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

Respuesta de muestra

status code:

200

{
  "name": "blue",
  "location": "westus2",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
  "type": "Microsoft.DeviceUpdate/accounts/instances",
  "properties": {
    "accountName": "contoso",
    "iotHubs": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
      }
    ],
    "enableDiagnostics": false,
    "diagnosticStorageProperties": {
      "authenticationType": "KeyBased",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
    }
  },
  "tags": {
    "tagKey": "tagValue"
  }
}

Definiciones

Nombre	Description
AuthenticationType	Tipo de autenticación
createdByType	Tipo de identidad que creó el recurso.
DiagnosticStorageProperties	Propiedades de almacenamiento de recopilación de registros de diagnóstico iniciadas por el cliente
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Instance	Detalles de la instancia de Device Update.
IotHubSettings	Integración de la cuenta de Device Update con la configuración de IoT Hub.
ProvisioningState	Estado de aprovisionamiento.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TagUpdate	Solicitud de carga usada para actualizar las etiquetas de un recurso existente.

AuthenticationType

Enumeración

Tipo de autenticación

Valor	Description
KeyBased

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DiagnosticStorageProperties

Object

Propiedades de almacenamiento de recopilación de registros de diagnóstico iniciadas por el cliente

Nombre	Tipo	Description
authenticationType	AuthenticationType	Tipo de autenticación
connectionString	string	ConnectionString de la cuenta de almacenamiento de diagnóstico
resourceId	string	ResourceId de la cuenta de almacenamiento de diagnóstico

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Instance

Object

Detalles de la instancia de Device Update.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.accountName	string	Nombre de cuenta de Device Update primario al que pertenece la instancia.
properties.diagnosticStorageProperties	DiagnosticStorageProperties	Propiedades de almacenamiento de recopilación de registros de diagnóstico iniciadas por el cliente
properties.enableDiagnostics	boolean	Habilita o deshabilita la recopilación de registros de diagnóstico
properties.iotHubs	IotHubSettings[]	Lista de ioT Hubs asociados a la cuenta.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IotHubSettings

Object

Integración de la cuenta de Device Update con la configuración de IoT Hub.

Nombre	Tipo	Description
resourceId	string minLength: 108 maxLength: 244	Identificador de recurso de IoTHub

ProvisioningState

Enumeración

Estado de aprovisionamiento.

Valor	Description
Accepted
Canceled
Creating
Deleted
Failed
Succeeded

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TagUpdate

Object

Solicitud de carga usada para actualizar las etiquetas de un recurso existente.

Nombre	Tipo	Description
tags	object	Lista de pares clave-valor que describen el recurso. Esto sobrescribirá las etiquetas existentes.