Accounts - Create

Serviço:

Device Update

Versão da API:

2023-07-01

Cria ou atualiza a Conta.

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

Parâmetros de URI

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
identity		ManagedServiceIdentity	O tipo de identidade usado para o recurso.
properties.encryption		Encryption	Criptografia cmk em propriedades rest
properties.privateEndpointConnections		PrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privado associadas à conta.
properties.publicNetworkAccess		PublicNetworkAccess	Se o acesso à rede pública é permitido ou não para a conta.
properties.sku		SKU	SKU de Atualização de Dispositivo
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
201 Created	Account	A operação assíncrona para criar ou atualizar a Conta 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.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

Creates or updates Account

Solicitação de exemplo

HTTP

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

{
  "location": "westus2",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "encryption": {
      "keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
      "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
    }
  }
}

Java

import com.azure.resourcemanager.deviceupdate.models.Encryption;
import com.azure.resourcemanager.deviceupdate.models.ManagedServiceIdentity;
import com.azure.resourcemanager.deviceupdate.models.ManagedServiceIdentityType;
import com.azure.resourcemanager.deviceupdate.models.UserAssignedIdentity;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Accounts Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Accounts/
     * Accounts_Create.json
     */
    /**
     * Sample code: Creates or updates Account.
     * 
     * @param manager Entry point to DeviceUpdateManager.
     */
    public static void createsOrUpdatesAccount(com.azure.resourcemanager.deviceupdate.DeviceUpdateManager manager) {
        manager.accounts().define("contoso").withRegion("westus2").withExistingResourceGroup("test-rg")
            .withIdentity(new ManagedServiceIdentity().withType(ManagedServiceIdentityType.USER_ASSIGNED)
                .withUserAssignedIdentities(mapOf(
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
                    new UserAssignedIdentity())))
            .withEncryption(new Encryption().withKeyVaultKeyUri("fakeTokenPlaceholder").withUserAssignedIdentity(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"))
            .create();
    }

    // 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 accounts_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.accounts.begin_create(
        resource_group_name="test-rg",
        account_name="contoso",
        account={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "location": "westus2",
            "properties": {
                "encryption": {
                    "keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
                    "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
                }
            },
        },
    ).result()
    print(response)


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

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/Accounts/Accounts_Create.json
func ExampleAccountsClient_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.NewAccountsClient().BeginCreate(ctx, "test-rg", "contoso", armdeviceupdate.Account{
		Location: to.Ptr("westus2"),
		Identity: &armdeviceupdate.ManagedServiceIdentity{
			Type: to.Ptr(armdeviceupdate.ManagedServiceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]*armdeviceupdate.UserAssignedIdentity{
				"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			},
		},
		Properties: &armdeviceupdate.AccountProperties{
			Encryption: &armdeviceupdate.Encryption{
				KeyVaultKeyURI:       to.Ptr("https://contoso.vault.azure.net/keys/contoso"),
				UserAssignedIdentity: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"),
			},
		},
	}, 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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates Account.
 *
 * @summary Creates or updates Account.
 * x-ms-original-file: specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/stable/2023-07-01/examples/Accounts/Accounts_Create.json
 */
async function createsOrUpdatesAccount() {
  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 account = {
    encryption: {
      keyVaultKeyUri: "https://contoso.vault.azure.net/keys/contoso",
      userAssignedIdentity:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
    },
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/00000000000000000000000000000000/resourceGroups/testRg/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    location: "westus2",
  };
  const credential = new DefaultAzureCredential();
  const client = new DeviceUpdate(credential, subscriptionId);
  const result = await client.accounts.beginCreateAndWait(resourceGroupName, accountName, account);
  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.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DeviceUpdate;

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

// get the collection of this DeviceUpdateAccountResource
DeviceUpdateAccountCollection collection = resourceGroupResource.GetDeviceUpdateAccounts();

// invoke the operation
string accountName = "contoso";
DeviceUpdateAccountData data = new DeviceUpdateAccountData(new AzureLocation("westus2"))
{
    Identity = new ManagedServiceIdentity("UserAssigned")
    {
        UserAssignedIdentities =
        {
        [new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1")] = new UserAssignedIdentity()
        },
    },
    Encryption = new DeviceUpdateEncryption
    {
        KeyVaultKeyUri = new Uri("https://contoso.vault.azure.net/keys/contoso"),
        UserAssignedIdentity = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"),
    },
};
ArmOperation<DeviceUpdateAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accountName, data);
DeviceUpdateAccountResource 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
DeviceUpdateAccountData 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

Resposta de exemplo

Código de status:

201

{
  "name": "contoso",
  "location": "westus2",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
  "type": "Microsoft.DeviceUpdate/accounts",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "12345678-1234-4321-1234-123456789012",
        "clientId": "12345678-4321-1234-1234-123456789012"
      }
    }
  },
  "properties": {
    "provisioningState": "Accepted",
    "hostName": "contoso.api.adu.microsoft.com",
    "sku": "Free",
    "encryption": {
      "keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
      "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
    },
    "locations": [
      {
        "name": "westus2",
        "role": "Primary"
      },
      {
        "name": "westcentralus",
        "role": "Failover"
      }
    ]
  }
}

Definições

Nome	Description
Account	Detalhes da conta de Atualização do Dispositivo.
createdByType	O tipo de identidade que criou o recurso.
Encryption	As configurações de criptografia do CMK na conta de Atualização de Dispositivo.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Location
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão do ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
ProvisioningState	Estado de provisionamento.
PublicNetworkAccess	Se o acesso à rede pública é permitido ou não para a conta.
Role	Se o local é primário ou failover
SKU	SKU de Atualização de Dispositivo
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

Account

Objeto

Detalhes da conta de Atualização do Dispositivo.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity		O tipo de identidade usado para o recurso.
location	string		A localização geográfica onde o recurso reside
name	string		O nome do recurso
properties.encryption	Encryption		Criptografia cmk em propriedades rest
properties.hostName	string		Nome do host da API.
properties.locations	Location[]		Detalhes do local primário e de failover da conta de Atualização do Dispositivo
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado associadas à conta.
properties.provisioningState	ProvisioningState		Estado de provisionamento.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Se o acesso à rede pública é permitido ou não para a conta.
properties.sku	SKU	Standard	SKU de Atualização de Dispositivo
systemData	systemData		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Encryption

Objeto

As configurações de criptografia do CMK na conta de Atualização de Dispositivo.

Nome	Tipo	Description
keyVaultKeyUri	string	O URI do cofre de chaves
userAssignedIdentity	string	A resourceId completa da identidade atribuída pelo usuário a ser usada para acesso ao cofre de chaves. A identidade também deve ser atribuída à Conta

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Location

Objeto

Nome	Tipo	Valor padrão	Description
name	string
role	Role	Primary	Se o local é primário ou failover

ManagedServiceIdentity

Objeto

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

Nome	Tipo	Description
principalId	string (uuid)	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string (uuid)	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string,  UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

PrivateEndpoint

Objeto

O recurso de ponto de extremidade privado.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado

PrivateEndpointConnection

Objeto

O recurso conexão de ponto de extremidade privado.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.groupIds	string[]	Matriz de IDs de grupo.
properties.privateEndpoint	PrivateEndpoint	O recurso do ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeração

O status da conexão do ponto de extremidade privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objeto

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome	Tipo	Description
actionsRequired	string	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da conexão.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Enumeração

Estado de provisionamento.

Valor	Description
Accepted
Canceled
Creating
Deleted
Failed
Succeeded

PublicNetworkAccess

Enumeração

Se o acesso à rede pública é permitido ou não para a conta.

Valor	Description
Disabled
Enabled

Role

Enumeração

Se o local é primário ou failover

Valor	Description
Failover
Primary

SKU

Enumeração

SKU de Atualização de Dispositivo

Valor	Description
Free
Standard

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.