Dev Box Definitions - List By Project

Referenz

Dienst:: Dev Center

API-Version:: 2024-02-01

Für ein Projekt konfigurierte Dev Box-Definitionen auflisten.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Der Name des Projekts.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$top	query		integer (int32)	Die maximale Anzahl von Ressourcen, die vom Vorgang zurückgegeben werden sollen. Beispiel: '$top=10'.

Antworten

Name	Typ	Beschreibung
200 OK	DevBoxDefinitionListResult	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

DevBoxDefinitions_ListByProject

Beispielanforderung

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


/**
 * 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

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

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

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CatalogResourceValidationStatus	Katalogressourcenüberprüfungsstatus
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DevBoxDefinition	Stellt eine Definition für einen Entwicklercomputer dar.
DevBoxDefinitionListResult	Ergebnisse des Dev Box-Definitionslistenvorgangs.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HibernateSupport	Gibt an, ob der Ruhezustand aktiviert/deaktiviert ist.
ImageReference	Bildreferenzinformationen
ImageValidationErrorDetails	Fehlerdetails zur Bildüberprüfung
ImageValidationStatus	Status der Bildüberprüfung
ProvisioningState	Bereitstellungsstatus der Ressource.
Sku	Die Definition des Ressourcenmodells, die SKU darstellt
SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CatalogResourceValidationStatus

Enumeration

Katalogressourcenüberprüfungsstatus

Wert	Beschreibung
Failed
Pending
Succeeded
Unknown

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DevBoxDefinition

Objekt

Stellt eine Definition für einen Entwicklercomputer dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.activeImageReference	ImageReference	Bildreferenzinformationen für das derzeit aktive Image (nur bei Updates aufgefüllt).
properties.hibernateSupport	HibernateSupport	Gibt an, ob dev Boxes, die mit dieser Definition erstellt wurden, in der Lage sind, ruhen zu können. Nicht alle Bilder sind in der Lage, den Ruhezustand zu unterstützen. Weitere Informationen finden Sie unter https://aka.ms/devbox/hibernate
properties.imageReference	ImageReference	Bildreferenzinformationen.
properties.imageValidationErrorDetails	ImageValidationErrorDetails	Details zum Fehler der Bild validator. Aufgefüllt, wenn die Bildüberprüfung nicht erfolgreich ist.
properties.imageValidationStatus	ImageValidationStatus	Überprüfungsstatus des konfigurierten Images.
properties.osStorageType	string	Der Speichertyp, der für den Betriebssystemdatenträger von Dev Boxes verwendet wird, der mit dieser Definition erstellt wurde.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Ressource.
properties.sku	Sku	Die mit dieser Definition erstellte SKU für Dev-Felder.
properties.validationStatus	CatalogResourceValidationStatus	Überprüfungsstatus für die Dev Box-Definition.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DevBoxDefinitionListResult

Objekt

Ergebnisse des Dev Box-Definitionslistenvorgangs.

Name	Typ	Beschreibung
nextLink	string	URL, um den nächsten Satz von Ergebnissen abzurufen, falls vorhanden.
value	DevBoxDefinition[]	Aktuelle Ergebnisseite.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HibernateSupport

Enumeration

Gibt an, ob der Ruhezustand aktiviert/deaktiviert ist.

Wert	Beschreibung
Disabled
Enabled

ImageReference

Objekt

Bildreferenzinformationen

Name	Typ	Beschreibung
exactVersion	string	Die tatsächliche Version des Bilds nach der Verwendung. Wenn die ID auf eine Katalogbildversion verweist, gibt dies die tatsächliche verwendete Version an.
id	string	Bild-ID oder Bildversions-ID. Wenn Bild-ID bereitgestellt wird, wird die neueste Version verwendet.

ImageValidationErrorDetails

Objekt

Fehlerdetails zur Bildüberprüfung

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler.
message	string	Eine Meldung, die den Fehler beschreibt.

ImageValidationStatus

Enumeration

Status der Bildüberprüfung

Wert	Beschreibung
Failed
Pending
Succeeded
TimedOut
Unknown

ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

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

Sku

Objekt

Die Definition des Ressourcenmodells, die SKU darstellt

Name	Typ	Beschreibung
capacity	integer (int32)	Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU. Z.B. P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.
size	string	Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code.
tier	SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

SkuTier

Enumeration

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

Wert	Beschreibung
Basic
Free
Premium
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Dev Box Definitions - List By Project

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

DevBoxDefinitions_ListByProject

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CatalogResourceValidationStatus

createdByType

DevBoxDefinition

DevBoxDefinitionListResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HibernateSupport

ImageReference

ImageValidationErrorDetails

ImageValidationStatus

ProvisioningState

Sku

SkuTier

systemData