Dev Box Definitions - Create Or Update

Service:

Dev Center

API-versie:

2024-02-01

Hiermee maakt of werkt u een Dev Box-definitie bij.

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

URI-parameters

Name	In	Vereist	Type	Description
devBoxDefinitionName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	De naam van de Dev Box-definitie.
devCenterName	path	True	string minLength: 3 maxLength: 26 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$	De naam van het devcenter.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De geografische locatie waar de resource zich bevindt
properties.imageReference	True	ImageReference	Referentie-informatie over afbeeldingen.
properties.sku	True	Sku	De SKU voor Dev Boxes die met deze definitie is gemaakt.
properties.hibernateSupport		HibernateSupport	Hiermee wordt aangegeven of Dev Boxes die met deze definitie zijn gemaakt, in de slaapstand kunnen worden gebracht. Niet alle afbeeldingen kunnen de sluimerstand ondersteunen. Zie https://aka.ms/devbox/hibernate voor meer informatie
properties.osStorageType		string	Het opslagtype dat wordt gebruikt voor de besturingssysteemschijf van Dev Boxes die met deze definitie is gemaakt.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	DevBoxDefinition	OK. De aanvraag is voltooid.
201 Created	DevBoxDefinition	Geschapen. De bewerking wordt asynchroon voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

DevBoxDefinitions_Create

Voorbeeldaanvraag

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Definities

Name	Description
CatalogResourceValidationStatus	Validatiestatus van catalogusresource
createdByType	Het type identiteit waarmee de resource is gemaakt.
DevBoxDefinition	Vertegenwoordigt een definitie voor een ontwikkelaarscomputer.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HibernateSupport	Geeft aan of sluimerstand is ingeschakeld/uitgeschakeld.
ImageReference	Naslaginformatie over afbeeldingen
ImageValidationErrorDetails	Details van afbeeldingsvalidatiefout
ImageValidationStatus	Validatiestatus van afbeelding
ProvisioningState	Inrichtingsstatus van de resource.
Sku	De definitie van het resourcemodel die de SKU vertegenwoordigt
SkuTier	Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CatalogResourceValidationStatus

Inventarisatie

Validatiestatus van catalogusresource

Waarde	Description
Unknown
Pending
Succeeded
Failed

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DevBoxDefinition

Object

Vertegenwoordigt een definitie voor een ontwikkelaarscomputer.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.activeImageReference	ImageReference	Referentie-informatie over de installatiekopieën voor de momenteel actieve installatiekopieën (alleen ingevuld tijdens updates).
properties.hibernateSupport	HibernateSupport	Hiermee wordt aangegeven of Dev Boxes die met deze definitie zijn gemaakt, in de slaapstand kunnen worden gebracht. Niet alle afbeeldingen kunnen de sluimerstand ondersteunen. Zie https://aka.ms/devbox/hibernate voor meer informatie
properties.imageReference	ImageReference	Referentie-informatie over afbeeldingen.
properties.imageValidationErrorDetails	ImageValidationErrorDetails	Details voor fout in afbeeldingsvalidatie. Ingevuld wanneer de afbeeldingsvalidatie niet is geslaagd.
properties.imageValidationStatus	ImageValidationStatus	Validatiestatus van de geconfigureerde installatiekopieën.
properties.osStorageType	string	Het opslagtype dat wordt gebruikt voor de besturingssysteemschijf van Dev Boxes die met deze definitie is gemaakt.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource.
properties.sku	Sku	De SKU voor Dev Boxes die met deze definitie is gemaakt.
properties.validationStatus	CatalogResourceValidationStatus	Validatiestatus voor de Dev Box-definitie.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HibernateSupport

Inventarisatie

Geeft aan of sluimerstand is ingeschakeld/uitgeschakeld.

Waarde	Description
Disabled
Enabled

ImageReference

Object

Naslaginformatie over afbeeldingen

Name	Type	Description
exactVersion	string	De werkelijke versie van de installatiekopieën na gebruik. Wanneer de id verwijst naar de nieuwste versie van een galerie-installatiekopieën, geeft dit de werkelijke versie aan die in gebruik is.
id	string	Afbeeldings-id of versie-id van installatiekopieën. Wanneer de installatiekopieën-id wordt opgegeven, wordt de meest recente versie gebruikt.

ImageValidationErrorDetails

Object

Details van afbeeldingsvalidatiefout

Name	Type	Description
code	string	Een id voor de fout.
message	string	Een bericht met een beschrijving van de fout.

ImageValidationStatus

Inventarisatie

Validatiestatus van afbeelding

Waarde	Description
Unknown
Pending
Succeeded
Failed
TimedOut

ProvisioningState

Inventarisatie

Inrichtingsstatus van de resource.

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

Sku

Object

De definitie van het resourcemodel die de SKU vertegenwoordigt

Name	Type	Description
capacity	integer (int32)	Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.
name	string	De naam van de SKU. Bijvoorbeeld P3. Dit is meestal een letter+cijfercode
size	string	De SKU-grootte. Wanneer het naamveld de combinatie van de laag en een andere waarde is, is dit de zelfstandige code.
tier	SkuTier	Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

SkuTier

Inventarisatie

Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

Waarde	Description
Free
Basic
Standard
Premium

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.