Instances - Create

Referência

Service:: Device Update

API Version:: 2023-07-01

Cria ou atualiza a instância.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	Nome da conta. Regex pattern: `^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
instanceName	path	True	string	Nome da instância. Regex pattern: `^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID de assinatura do Azure.
api-version	query	True	string	Versão da API de esquema da ADU.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica em que o recurso reside
properties.diagnosticStorageProperties		DiagnosticStorageProperties	Propriedades de armazenamento da coleção de logs de diagnóstico iniciadas pelo cliente
properties.enableDiagnostics		boolean	Habilita ou desabilita a coleção de logs de diagnóstico
properties.iotHubs		IotHubSettings[]	Lista de Hubs IoT associados à conta.
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
201 Created	Instance	A operação assíncrona para criar ou atualizar a Instância foi criada.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo da falha na operação.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

Creates or updates Instance

Sample Request

PUT 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

{
  "location": "westus2",
  "properties": {
    "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",
      "connectionString": "string"
    }
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.deviceupdate import DeviceUpdateMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-deviceupdate
# USAGE
    python instances_create.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.begin_create(
        resource_group_name="test-rg",
        account_name="contoso",
        instance_name="blue",
        instance={
            "location": "westus2",
            "properties": {
                "diagnosticStorageProperties": {
                    "authenticationType": "KeyBased",
                    "connectionString": "string",
                    "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount",
                },
                "enableDiagnostics": False,
                "iotHubs": [
                    {
                        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
                    }
                ],
            },
        },
    ).result()
    print(response)


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

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_Create.json
func ExampleInstancesClient_BeginCreate() {
	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)
	}
	poller, err := clientFactory.NewInstancesClient().BeginCreate(ctx, "test-rg", "contoso", "blue", armdeviceupdate.Instance{
		Location: to.Ptr("westus2"),
		Properties: &armdeviceupdate.InstanceProperties{
			DiagnosticStorageProperties: &armdeviceupdate.DiagnosticStorageProperties{
				AuthenticationType: to.Ptr(armdeviceupdate.AuthenticationTypeKeyBased),
				ConnectionString:   to.Ptr("string"),
				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"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

const { DeviceUpdate } = require("@azure/arm-deviceupdate");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates instance.
 *
 * @summary Creates or updates instance.
 * x-ms-original-file: specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Instances/Instances_Create.json
 */
async function createsOrUpdatesInstance() {
  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 instance = {
    diagnosticStorageProperties: {
      authenticationType: "KeyBased",
      connectionString: "string",
      resourceId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount",
    },
    enableDiagnostics: false,
    iotHubs: [
      {
        resourceId:
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub",
      },
    ],
    location: "westus2",
  };
  const credential = new DefaultAzureCredential();
  const client = new DeviceUpdate(credential, subscriptionId);
  const result = await client.instances.beginCreateAndWait(
    resourceGroupName,
    accountName,
    instanceName,
    instance,
  );
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DeviceUpdate;
using Azure.ResourceManager.DeviceUpdate.Models;

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

// get the collection of this DeviceUpdateInstanceResource
DeviceUpdateInstanceCollection collection = deviceUpdateAccount.GetDeviceUpdateInstances();

// invoke the operation
string instanceName = "blue";
DeviceUpdateInstanceData data = new DeviceUpdateInstanceData(new AzureLocation("westus2"))
{
    IotHubs =
    {
    new DeviceUpdateIotHubSettings(new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"))
    },
    EnableDiagnostics = false,
    DiagnosticStorageProperties = new DiagnosticStorageProperties(DiagnosticStorageAuthenticationType.KeyBased, new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"))
    {
        ConnectionString = "string",
    },
};
ArmOperation<DeviceUpdateInstanceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, instanceName, data);
DeviceUpdateInstanceResource result = lro.Value;

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

Sample Response

Status code:: 201

{
  "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": {
    "provisioningState": "Accepted",
    "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"
    }
  }
}

Definições

Nome	Description
AuthenticationType	Tipo de autenticação
createdByType	O tipo de identidade que criou o recurso.
DiagnosticStorageProperties	Propriedades de armazenamento da coleção de logs de diagnóstico iniciadas pelo cliente
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Instance	Detalhes da instância de Atualização de Dispositivo.
IotHubSettings	Integração da conta de Atualização de Dispositivo com Hub IoT configurações.
ProvisioningState	Estado de provisionamento.
systemData	Metadados relativos à criação e à última modificação do recurso.

AuthenticationType

Tipo de autenticação

Nome	Tipo	Description
KeyBased	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DiagnosticStorageProperties

Propriedades de armazenamento da coleção de logs de diagnóstico iniciadas pelo cliente

Nome	Tipo	Description
authenticationType	AuthenticationType	Tipo de autenticação
connectionString	string	ConnectionString da conta de armazenamento de diagnóstico
resourceId	string	ResourceId da conta de armazenamento de diagnóstico

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Instance

Detalhes da instância de Atualização de Dispositivo.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.accountName	string	Nome da conta de atualização de dispositivo pai ao qual a Instância pertence.
properties.diagnosticStorageProperties	DiagnosticStorageProperties	Propriedades de armazenamento da coleção de logs de diagnóstico iniciadas pelo cliente
properties.enableDiagnostics	boolean	Habilita ou desabilita a coleção de logs de diagnóstico
properties.iotHubs	IotHubSettings[]	Lista de Hubs IoT associados à conta.
properties.provisioningState	ProvisioningState	Estado de provisionamento.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IotHubSettings

Integração da conta de Atualização de Dispositivo com Hub IoT configurações.

Nome	Tipo	Description
resourceId	string	ID do recurso do IoTHub

ProvisioningState

Estado de provisionamento.

Nome	Tipo	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Failed	string
Succeeded	string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Instances - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

Creates or updates Instance

Sample Request

Sample Response

Definições

AuthenticationType

createdByType

DiagnosticStorageProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Instance

IotHubSettings

ProvisioningState

systemData

Recursos adicionais