Instances - Create

Odwołanie

Service:: Device Update

API Version:: 2023-07-01

Tworzy lub aktualizuje wystąpienie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta. Regex pattern: `^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
instanceName	path	True	string	Nazwa wystąpienia. Regex pattern: `^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure.
api-version	query	True	string	Wersja interfejsu API schematu usługi ADU.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
properties.diagnosticStorageProperties		DiagnosticStorageProperties	Właściwości magazynu zbierania dzienników diagnostycznych zainicjowane przez klienta
properties.enableDiagnostics		boolean	Włącza lub wyłącza zbieranie dzienników diagnostycznych
properties.iotHubs		IotHubSettings[]	Lista centrów IoT Hub skojarzonych z kontem.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Instance	Utworzono operację asynchronizową w celu utworzenia lub zaktualizowania wystąpienia.
Other Status Codes	ErrorResponse	Odpowiedź o błędzie opisująca przyczynę niepowodzenia operacji.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

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

Definicje

Nazwa	Opis
AuthenticationType	Typ uwierzytelniania
createdByType	Typ tożsamości, która utworzyła zasób.
DiagnosticStorageProperties	Właściwości magazynu zbierania dzienników diagnostycznych zainicjowane przez klienta
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Instance	Szczegóły wystąpienia usługi Device Update.
IotHubSettings	Integracja konta usługi Device Update z ustawieniami IoT Hub.
ProvisioningState	Stan aprowizacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AuthenticationType

Typ uwierzytelniania

Nazwa	Typ	Opis
KeyBased	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DiagnosticStorageProperties

Właściwości magazynu zbierania dzienników diagnostycznych zainicjowane przez klienta

Nazwa	Typ	Opis
authenticationType	AuthenticationType	Typ uwierzytelniania
connectionString	string	ConnectionString konta magazynu diagnostycznego
resourceId	string	ResourceId konta magazynu diagnostycznego

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Instance

Szczegóły wystąpienia usługi Device Update.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.accountName	string	Nadrzędna nazwa konta aktualizacji urządzenia, do którego należy wystąpienie.
properties.diagnosticStorageProperties	DiagnosticStorageProperties	Właściwości magazynu zbierania dzienników diagnostycznych zainicjowane przez klienta
properties.enableDiagnostics	boolean	Włącza lub wyłącza zbieranie dzienników diagnostycznych
properties.iotHubs	IotHubSettings[]	Lista centrów IoT Hub skojarzonych z kontem.
properties.provisioningState	ProvisioningState	Stan aprowizacji.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

IotHubSettings

Integracja konta usługi Device Update z ustawieniami IoT Hub.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu usługi IoTHub

ProvisioningState

Stan aprowizacji.

Nazwa	Typ	Opis
Accepted	string
Canceled	string
Creating	string
Deleted	string
Failed	string
Succeeded	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Instances - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Creates or updates Instance

Sample Request

Sample Response

Definicje

AuthenticationType

createdByType

DiagnosticStorageProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Instance

IotHubSettings

ProvisioningState

systemData

Dodatkowe zasoby