Dev Box Definitions - Create Or Update

Servicio:: Dev Center

Versión de la API:: 2024-02-01

Crea o actualiza una definición de Dev Box.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}?api-version=2024-02-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
devBoxDefinitionName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Nombre de la definición de Dev Box.
devCenterName	path	True	string minLength: 3 maxLength: 26 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$	Nombre del centro de desarrollo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso
properties.imageReference	True	ImageReference	Información de referencia de imagen.
properties.sku	True	Sku	La SKU para Dev Boxes creada con esta definición.
properties.hibernateSupport		HibernateSupport	Indica si Los cuadros de desarrollo creados con esta definición son capaces de hibernación. No todas las imágenes son capaces de admitir la hibernación. Para obtener más información, consulte https://aka.ms/devbox/hibernate
properties.osStorageType		string	El tipo de almacenamiento usado para el disco del sistema operativo de Dev Boxes creado con esta definición.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	DevBoxDefinition	De acuerdo. La solicitud se ha realizado correctamente.
201 Created	DevBoxDefinition	Creado. La operación se completará de forma asincrónica.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en 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

DevBoxDefinitions_Create

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox?api-version=2024-02-01

{
  "properties": {
    "imageReference": {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"
    },
    "sku": {
      "name": "Preview"
    },
    "hibernateSupport": "Enabled"
  },
  "location": "centralus"
}


import com.azure.resourcemanager.devcenter.models.HibernateSupport;
import com.azure.resourcemanager.devcenter.models.ImageReference;
import com.azure.resourcemanager.devcenter.models.Sku;

/**
 * Samples for DevBoxDefinitions CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Create.
     * json
     */
    /**
     * Sample code: DevBoxDefinitions_Create.
     * 
     * @param manager Entry point to DevCenterManager.
     */
    public static void devBoxDefinitionsCreate(com.azure.resourcemanager.devcenter.DevCenterManager manager) {
        manager.devBoxDefinitions().define("WebDevBox").withRegion("centralus").withExistingDevcenter("rg1", "Contoso")
            .withImageReference(new ImageReference().withId(
                "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"))
            .withSku(new Sku().withName("Preview")).withHibernateSupport(HibernateSupport.ENABLED).create();
    }
}

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.devcenter import DevCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devcenter
# USAGE
    python dev_box_definitions_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 = DevCenterMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="0ac520ee-14c0-480f-b6c9-0a90c58ffff",
    )

    response = client.dev_box_definitions.begin_create_or_update(
        resource_group_name="rg1",
        dev_center_name="Contoso",
        dev_box_definition_name="WebDevBox",
        body={
            "location": "centralus",
            "properties": {
                "hibernateSupport": "Enabled",
                "imageReference": {
                    "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"
                },
                "sku": {"name": "Preview"},
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_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 armdevcenter_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/devcenter/armdevcenter/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Create.json
func ExampleDevBoxDefinitionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevcenter.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevBoxDefinitionsClient().BeginCreateOrUpdate(ctx, "rg1", "Contoso", "WebDevBox", armdevcenter.DevBoxDefinition{
		Location: to.Ptr("centralus"),
		Properties: &armdevcenter.DevBoxDefinitionProperties{
			HibernateSupport: to.Ptr(armdevcenter.HibernateSupportEnabled),
			ImageReference: &armdevcenter.ImageReference{
				ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"),
			},
			SKU: &armdevcenter.SKU{
				Name: to.Ptr("Preview"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.DevBoxDefinition = armdevcenter.DevBoxDefinition{
	// 	Name: to.Ptr("WebDevBox"),
	// 	Type: to.Ptr("Microsoft.DevCenter/devcenters/devboxdefinitions"),
	// 	ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName"),
	// 	SystemData: &armdevcenter.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:00:36.993Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdevcenter.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T18:30:36.993Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user1"),
	// 		LastModifiedByType: to.Ptr(armdevcenter.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("centralus"),
	// 	Properties: &armdevcenter.DevBoxDefinitionProperties{
	// 		HibernateSupport: to.Ptr(armdevcenter.HibernateSupportEnabled),
	// 		ImageReference: &armdevcenter.ImageReference{
	// 			ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"),
	// 		},
	// 		SKU: &armdevcenter.SKU{
	// 			Name: to.Ptr("Preview"),
	// 		},
	// 		ProvisioningState: to.Ptr(armdevcenter.ProvisioningStateSucceeded),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Creates or updates a Dev Box definition.
 *
 * @summary Creates or updates a Dev Box definition.
 * x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_Create.json
 */
async function devBoxDefinitionsCreate() {
  const subscriptionId =
    process.env["DEVCENTER_SUBSCRIPTION_ID"] || "0ac520ee-14c0-480f-b6c9-0a90c58ffff";
  const resourceGroupName = process.env["DEVCENTER_RESOURCE_GROUP"] || "rg1";
  const devCenterName = "Contoso";
  const devBoxDefinitionName = "WebDevBox";
  const body = {
    hibernateSupport: "Enabled",
    imageReference: {
      id: "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0",
    },
    location: "centralus",
    sku: { name: "Preview" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevCenterClient(credential, subscriptionId);
  const result = await client.devBoxDefinitions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    devCenterName,
    devBoxDefinitionName,
    body,
  );
  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

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName",
  "name": "WebDevBox",
  "type": "Microsoft.DevCenter/devcenters/devboxdefinitions",
  "properties": {
    "imageReference": {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"
    },
    "sku": {
      "name": "Preview"
    },
    "hibernateSupport": "Enabled",
    "provisioningState": "Succeeded"
  },
  "location": "centralus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-11-18T18:00:36.993Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-11-18T18:30:36.993Z"
  }
}

status code:: 201

{
  "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName",
  "name": "WebDevBox",
  "type": "Microsoft.DevCenter/devcenters/devboxdefinitions",
  "properties": {
    "imageReference": {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0"
    },
    "sku": {
      "name": "Preview"
    },
    "hibernateSupport": "Enabled",
    "provisioningState": "Created"
  },
  "location": "centralus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-11-18T18:00:36.993Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-11-18T18:30:36.993Z"
  }
}

Definiciones

Nombre	Description
CatalogResourceValidationStatus	Estado de validación de recursos del catálogo
createdByType	Tipo de identidad que creó el recurso.
DevBoxDefinition	Representa una definición para un equipo para desarrolladores.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
HibernateSupport	Indica si la hibernación está habilitada o deshabilitada.
ImageReference	Información de referencia de imagen
ImageValidationErrorDetails	Detalles del error de validación de imágenes
ImageValidationStatus	Estado de validación de imágenes
ProvisioningState	Estado de aprovisionamiento del recurso.
Sku	Definición del modelo de recursos que representa la SKU
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
systemData	Metadatos relativos a la creación y última modificación del recurso.

CatalogResourceValidationStatus

Enumeración

Estado de validación de recursos del catálogo

Valor	Description
Unknown
Pending
Succeeded
Failed

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DevBoxDefinition

Object

Representa una definición para un equipo para desarrolladores.

Nombre	Tipo	Description
id	string (arm-id)	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.activeImageReference	ImageReference	Información de referencia de imagen para la imagen activa actualmente (solo se rellena durante las actualizaciones).
properties.hibernateSupport	HibernateSupport	Indica si Los cuadros de desarrollo creados con esta definición son capaces de hibernación. No todas las imágenes son capaces de admitir la hibernación. Para obtener más información, consulte https://aka.ms/devbox/hibernate
properties.imageReference	ImageReference	Información de referencia de imagen.
properties.imageValidationErrorDetails	ImageValidationErrorDetails	Detalles del error del validador de imágenes. Se rellena cuando la validación de la imagen no se realiza correctamente.
properties.imageValidationStatus	ImageValidationStatus	Estado de validación de la imagen configurada.
properties.osStorageType	string	El tipo de almacenamiento usado para el disco del sistema operativo de Dev Boxes creado con esta definición.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
properties.sku	Sku	La SKU para Dev Boxes creada con esta definición.
properties.validationStatus	CatalogResourceValidationStatus	Estado de validación para la definición del cuadro de desarrollo.
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"

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.

HibernateSupport

Enumeración

Indica si la hibernación está habilitada o deshabilitada.

Valor	Description
Disabled
Enabled

ImageReference

Object

Información de referencia de imagen

Nombre	Tipo	Description
exactVersion	string	Versión real de la imagen después de su uso. Cuando id hace referencia a una versión más reciente de la imagen de la galería, esto indicará la versión real en uso.
id	string	Id. de imagen o Id. de versión de imagen. Cuando se proporciona el identificador de imagen, se usará su versión más reciente.

ImageValidationErrorDetails

Object

Detalles del error de validación de imágenes

Nombre	Tipo	Description
code	string	Identificador del error.
message	string	Mensaje que describe el error.

ImageValidationStatus

Enumeración

Estado de validación de imágenes

Valor	Description
Unknown
Pending
Succeeded
Failed
TimedOut

ProvisioningState

Enumeración

Estado de aprovisionamiento del recurso.

Valor	Description
NotSpecified
Accepted
Running
Creating
Created
Updating
Updated
Deleting
Deleted
Succeeded
Failed
Canceled
MovingResources
TransientFailure
RolloutInProgress
StorageProvisioningFailed

Sku

Object

Definición del modelo de recursos que representa la SKU

Nombre	Tipo	Description
capacity	integer (int32)	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	Nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuTier

Enumeración

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor	Description
Free
Basic
Standard
Premium

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.