Dev Box Definitions - List By Project

Servizio:

Dev Center

Versione API:

2024-02-01

Elencare le definizioni di Dev Box configurate per un progetto.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions?api-version=2024-02-01

Con parametri facoltativi:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions?api-version=2024-02-01&$top={$top}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Nome del progetto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$top	query		integer (int32)	Numero massimo di risorse da restituire dall'operazione. Esempio: '$top=10'.

Risposte

Nome	Tipo	Descrizione
200 OK	DevBoxDefinitionListResult	OK. La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DevBoxDefinitions_ListByProject

Esempio di richiesta

HTTP

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

Java

/**
 * Samples for DevBoxDefinitions ListByProject.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/
     * DevBoxDefinitions_ListByProject.json
     */
    /**
     * Sample code: DevBoxDefinitions_ListByProject.
     * 
     * @param manager Entry point to DevCenterManager.
     */
    public static void devBoxDefinitionsListByProject(com.azure.resourcemanager.devcenter.DevCenterManager manager) {
        manager.devBoxDefinitions().listByProject("rg1", "ContosoProject", null, com.azure.core.util.Context.NONE);
    }
}

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.devcenter import DevCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devcenter
# USAGE
    python dev_box_definitions_list_by_project.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.list_by_project(
        resource_group_name="rg1",
        project_name="ContosoProject",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_ListByProject.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/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_ListByProject.json
func ExampleDevBoxDefinitionsClient_NewListByProjectPager() {
	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)
	}
	pager := clientFactory.NewDevBoxDefinitionsClient().NewListByProjectPager("rg1", "ContosoProject", &armdevcenter.DevBoxDefinitionsClientListByProjectOptions{Top: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DevBoxDefinitionListResult = armdevcenter.DevBoxDefinitionListResult{
		// 	Value: []*armdevcenter.DevBoxDefinition{
		// 		{
		// 			Name: to.Ptr("WebDevBox"),
		// 			Type: to.Ptr("Microsoft.DevCenter/projects/devboxdefinitions"),
		// 			ID: to.Ptr("/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox"),
		// 			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 List Dev Box definitions configured for a project.
 *
 * @summary List Dev Box definitions configured for a project.
 * x-ms-original-file: specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxDefinitions_ListByProject.json
 */
async function devBoxDefinitionsListByProject() {
  const subscriptionId =
    process.env["DEVCENTER_SUBSCRIPTION_ID"] || "0ac520ee-14c0-480f-b6c9-0a90c58ffff";
  const resourceGroupName = process.env["DEVCENTER_RESOURCE_GROUP"] || "rg1";
  const projectName = "ContosoProject";
  const credential = new DefaultAzureCredential();
  const client = new DevCenterClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.devBoxDefinitions.listByProject(resourceGroupName, projectName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox",
      "name": "WebDevBox",
      "type": "Microsoft.DevCenter/projects/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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CatalogResourceValidationStatus	Stato di convalida delle risorse del catalogo
createdByType	Tipo di identità che ha creato la risorsa.
DevBoxDefinition	Rappresenta una definizione per un computer per sviluppatori.
DevBoxDefinitionListResult	Risultati dell'operazione di elenco delle definizioni di Dev Box.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
HibernateSupport	Indica se l'ibernazione è abilitata/disabilitata.
ImageReference	Informazioni di riferimento sulle immagini
ImageValidationErrorDetails	Dettagli dell'errore di convalida delle immagini
ImageValidationStatus	Stato di convalida dell'immagine
ProvisioningState	Stato di provisioning della risorsa.
Sku	Definizione del modello di risorse che rappresenta lo SKU
SkuTier	Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CatalogResourceValidationStatus

Enumerazione

Stato di convalida delle risorse del catalogo

Valore	Descrizione
Unknown
Pending
Succeeded
Failed

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DevBoxDefinition

Object

Rappresenta una definizione per un computer per sviluppatori.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.activeImageReference	ImageReference	Informazioni di riferimento sulle immagini per l'immagine attualmente attiva (popolata solo durante gli aggiornamenti).
properties.hibernateSupport	HibernateSupport	Indica se Dev Boxes creato con questa definizione è in grado di ibernare. Non tutte le immagini sono in grado di supportare l'ibernazione. Per altre informazioni, vedere https://aka.ms/devbox/hibernate
properties.imageReference	ImageReference	Informazioni di riferimento sulle immagini.
properties.imageValidationErrorDetails	ImageValidationErrorDetails	Dettagli per l'errore del validator dell'immagine. Popolato quando la convalida dell'immagine non riesce.
properties.imageValidationStatus	ImageValidationStatus	Stato di convalida dell'immagine configurata.
properties.osStorageType	string	Tipo di archiviazione usato per il disco del sistema operativo di Dev Boxes creato usando questa definizione.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa.
properties.sku	Sku	SKU per Dev Boxes creato usando questa definizione.
properties.validationStatus	CatalogResourceValidationStatus	Stato di convalida per la definizione di Dev Box.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DevBoxDefinitionListResult

Object

Risultati dell'operazione di elenco delle definizioni di Dev Box.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set di risultati successivo, se presente.
value	DevBoxDefinition[]	Pagina corrente dei risultati.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

HibernateSupport

Enumerazione

Indica se l'ibernazione è abilitata/disabilitata.

Valore	Descrizione
Disabled
Enabled

ImageReference

Object

Informazioni di riferimento sulle immagini

Nome	Tipo	Descrizione
exactVersion	string	Versione effettiva dell'immagine dopo l'uso. Quando id fa riferimento a un'immagine della raccolta versione più recente, indicherà la versione effettiva in uso.
id	string	ID immagine o ID versione immagine. Quando viene specificato l'ID immagine, verrà usata la versione più recente.

ImageValidationErrorDetails

Object

Dettagli dell'errore di convalida delle immagini

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore.
message	string	Messaggio che descrive l'errore.

ImageValidationStatus

Enumerazione

Stato di convalida dell'immagine

Valore	Descrizione
Unknown
Pending
Succeeded
Failed
TimedOut

ProvisioningState

Enumerazione

Stato di provisioning della risorsa.

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

Sku

Object

Definizione del modello di risorse che rappresenta lo SKU

Nome	Tipo	Descrizione
capacity	integer (int32)	Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.
name	string	Nome dello SKU. Ad esempio P3. Si tratta in genere di un codice lettera+numero
size	string	Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo.
tier	SkuTier	Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

SkuTier

Enumerazione

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

Valore	Descrizione
Free
Basic
Standard
Premium

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.