diff --git a/src/devcenter/HISTORY.rst b/src/devcenter/HISTORY.rst index 1c139576ba0..31eacf7cb3c 100644 --- a/src/devcenter/HISTORY.rst +++ b/src/devcenter/HISTORY.rst @@ -3,6 +3,10 @@ Release History =============== +0.1.1 +* Fix wrong command group name +* Add correct author email + 0.1.0 ++++++ * Initial release. diff --git a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/__cmd_group.py b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/__cmd_group.py similarity index 94% rename from src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/__cmd_group.py rename to src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/__cmd_group.py index e7ea82ed59d..e735f6c90bd 100644 --- a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/__cmd_group.py +++ b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/__cmd_group.py @@ -12,7 +12,7 @@ @register_command_group( - "devcenter admin image-verion", + "devcenter admin image-version", is_preview=True, ) class __CMDGroup(AAZCommandGroup): diff --git a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/__init__.py b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/__init__.py similarity index 100% rename from src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/__init__.py rename to src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/__init__.py diff --git a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/_list.py b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/_list.py similarity index 99% rename from src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/_list.py rename to src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/_list.py index ffd6db0593f..645302f8cbf 100644 --- a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/_list.py +++ b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/_list.py @@ -12,7 +12,7 @@ @register_command( - "devcenter admin image-verion list", + "devcenter admin image-version list", is_preview=True, ) class List(AAZCommand): diff --git a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/_show.py b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/_show.py similarity index 99% rename from src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/_show.py rename to src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/_show.py index 7098d5164d5..384dc92e5a5 100644 --- a/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_verion/_show.py +++ b/src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/image_version/_show.py @@ -12,7 +12,7 @@ @register_command( - "devcenter admin image-verion show", + "devcenter admin image-version show", is_preview=True, ) class Show(AAZCommand): diff --git a/src/devcenter/azext_devcenter/custom.py b/src/devcenter/azext_devcenter/custom.py index 20b262b26e6..99837f0f7d6 100644 --- a/src/devcenter/azext_devcenter/custom.py +++ b/src/devcenter/azext_devcenter/custom.py @@ -51,7 +51,7 @@ List as _ImageList, Show as _ImageShow, ) -from .aaz.latest.devcenter.admin.image_verion import ( +from .aaz.latest.devcenter.admin.image_version import ( List as _ImageVersionList, Show as _ImageVersionShow, ) diff --git a/src/devcenter/report.md b/src/devcenter/report.md deleted file mode 100644 index 91415e20367..00000000000 --- a/src/devcenter/report.md +++ /dev/null @@ -1,1862 +0,0 @@ -# Azure CLI Module Creation Report - -## EXTENSION -|CLI Extension|Command Groups| -|---------|------------| -|az devcenter|[groups](#CommandGroups) - -## GROUPS -### Command groups in `az devcenter` extension -|CLI Command Group|Group Swagger name|Commands| -|---------|------------|--------| -|az devcenter attached-network|AttachedNetworks|[commands](#CommandsInAttachedNetworks)| -|az devcenter catalog|Catalogs|[commands](#CommandsInCatalogs)| -|az devcenter check-name-availability|CheckNameAvailability|[commands](#CommandsInCheckNameAvailability)| -|az devcenter dev-box-definition|DevBoxDefinitions|[commands](#CommandsInDevBoxDefinitions)| -|az devcenter dev-center|DevCenters|[commands](#CommandsInDevCenters)| -|az devcenter environment-type|EnvironmentTypes|[commands](#CommandsInEnvironmentTypes)| -|az devcenter gallery|Galleries|[commands](#CommandsInGalleries)| -|az devcenter image|Images|[commands](#CommandsInImages)| -|az devcenter image-version|ImageVersions|[commands](#CommandsInImageVersions)| -|az devcenter network-connection|NetworkConnections|[commands](#CommandsInNetworkConnections)| -|az devcenter operation-statuses|OperationStatuses|[commands](#CommandsInOperationStatuses)| -|az devcenter pool|Pools|[commands](#CommandsInPools)| -|az devcenter project|Projects|[commands](#CommandsInProjects)| -|az devcenter project-allowed-environment-type|ProjectAllowedEnvironmentTypes|[commands](#CommandsInProjectAllowedEnvironmentTypes)| -|az devcenter project-environment-type|ProjectEnvironmentTypes|[commands](#CommandsInProjectEnvironmentTypes)| -|az devcenter schedule|Schedules|[commands](#CommandsInSchedules)| -|az devcenter sku|Skus|[commands](#CommandsInSkus)| -|az devcenter usage|Usages|[commands](#CommandsInUsages)| - -## COMMANDS -### Commands in `az devcenter attached-network` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter attached-network list](#AttachedNetworksListByProject)|ListByProject|[Parameters](#ParametersAttachedNetworksListByProject)|[Example](#ExamplesAttachedNetworksListByProject)| -|[az devcenter attached-network list](#AttachedNetworksListByDevCenter)|ListByDevCenter|[Parameters](#ParametersAttachedNetworksListByDevCenter)|[Example](#ExamplesAttachedNetworksListByDevCenter)| -|[az devcenter attached-network show](#AttachedNetworksGetByProject)|GetByProject|[Parameters](#ParametersAttachedNetworksGetByProject)|[Example](#ExamplesAttachedNetworksGetByProject)| -|[az devcenter attached-network show](#AttachedNetworksGetByDevCenter)|GetByDevCenter|[Parameters](#ParametersAttachedNetworksGetByDevCenter)|[Example](#ExamplesAttachedNetworksGetByDevCenter)| -|[az devcenter attached-network create](#AttachedNetworksCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersAttachedNetworksCreateOrUpdate#Create)|[Example](#ExamplesAttachedNetworksCreateOrUpdate#Create)| -|[az devcenter attached-network update](#AttachedNetworksCreateOrUpdate#Update)|CreateOrUpdate#Update|[Parameters](#ParametersAttachedNetworksCreateOrUpdate#Update)|Not Found| -|[az devcenter attached-network delete](#AttachedNetworksDelete)|Delete|[Parameters](#ParametersAttachedNetworksDelete)|[Example](#ExamplesAttachedNetworksDelete)| - -### Commands in `az devcenter catalog` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter catalog list](#CatalogsListByDevCenter)|ListByDevCenter|[Parameters](#ParametersCatalogsListByDevCenter)|[Example](#ExamplesCatalogsListByDevCenter)| -|[az devcenter catalog show](#CatalogsGet)|Get|[Parameters](#ParametersCatalogsGet)|[Example](#ExamplesCatalogsGet)| -|[az devcenter catalog create](#CatalogsCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersCatalogsCreateOrUpdate#Create)|[Example](#ExamplesCatalogsCreateOrUpdate#Create)| -|[az devcenter catalog update](#CatalogsUpdate)|Update|[Parameters](#ParametersCatalogsUpdate)|[Example](#ExamplesCatalogsUpdate)| -|[az devcenter catalog delete](#CatalogsDelete)|Delete|[Parameters](#ParametersCatalogsDelete)|[Example](#ExamplesCatalogsDelete)| -|[az devcenter catalog sync](#CatalogsSync)|Sync|[Parameters](#ParametersCatalogsSync)|[Example](#ExamplesCatalogsSync)| - -### Commands in `az devcenter check-name-availability` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter check-name-availability execute](#CheckNameAvailabilityExecute)|Execute|[Parameters](#ParametersCheckNameAvailabilityExecute)|[Example](#ExamplesCheckNameAvailabilityExecute)| - -### Commands in `az devcenter dev-box-definition` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter dev-box-definition list](#DevBoxDefinitionsListByDevCenter)|ListByDevCenter|[Parameters](#ParametersDevBoxDefinitionsListByDevCenter)|[Example](#ExamplesDevBoxDefinitionsListByDevCenter)| -|[az devcenter dev-box-definition list](#DevBoxDefinitionsListByProject)|ListByProject|[Parameters](#ParametersDevBoxDefinitionsListByProject)|[Example](#ExamplesDevBoxDefinitionsListByProject)| -|[az devcenter dev-box-definition show](#DevBoxDefinitionsGet)|Get|[Parameters](#ParametersDevBoxDefinitionsGet)|[Example](#ExamplesDevBoxDefinitionsGet)| -|[az devcenter dev-box-definition show](#DevBoxDefinitionsGetByProject)|GetByProject|[Parameters](#ParametersDevBoxDefinitionsGetByProject)|[Example](#ExamplesDevBoxDefinitionsGetByProject)| -|[az devcenter dev-box-definition create](#DevBoxDefinitionsCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersDevBoxDefinitionsCreateOrUpdate#Create)|[Example](#ExamplesDevBoxDefinitionsCreateOrUpdate#Create)| -|[az devcenter dev-box-definition update](#DevBoxDefinitionsUpdate)|Update|[Parameters](#ParametersDevBoxDefinitionsUpdate)|[Example](#ExamplesDevBoxDefinitionsUpdate)| -|[az devcenter dev-box-definition delete](#DevBoxDefinitionsDelete)|Delete|[Parameters](#ParametersDevBoxDefinitionsDelete)|[Example](#ExamplesDevBoxDefinitionsDelete)| - -### Commands in `az devcenter dev-center` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter dev-center list](#DevCentersListByResourceGroup)|ListByResourceGroup|[Parameters](#ParametersDevCentersListByResourceGroup)|[Example](#ExamplesDevCentersListByResourceGroup)| -|[az devcenter dev-center list](#DevCentersListBySubscription)|ListBySubscription|[Parameters](#ParametersDevCentersListBySubscription)|[Example](#ExamplesDevCentersListBySubscription)| -|[az devcenter dev-center show](#DevCentersGet)|Get|[Parameters](#ParametersDevCentersGet)|[Example](#ExamplesDevCentersGet)| -|[az devcenter dev-center create](#DevCentersCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersDevCentersCreateOrUpdate#Create)|[Example](#ExamplesDevCentersCreateOrUpdate#Create)| -|[az devcenter dev-center update](#DevCentersUpdate)|Update|[Parameters](#ParametersDevCentersUpdate)|[Example](#ExamplesDevCentersUpdate)| -|[az devcenter dev-center delete](#DevCentersDelete)|Delete|[Parameters](#ParametersDevCentersDelete)|[Example](#ExamplesDevCentersDelete)| - -### Commands in `az devcenter environment-type` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter environment-type list](#EnvironmentTypesListByDevCenter)|ListByDevCenter|[Parameters](#ParametersEnvironmentTypesListByDevCenter)|[Example](#ExamplesEnvironmentTypesListByDevCenter)| -|[az devcenter environment-type show](#EnvironmentTypesGet)|Get|[Parameters](#ParametersEnvironmentTypesGet)|[Example](#ExamplesEnvironmentTypesGet)| -|[az devcenter environment-type create](#EnvironmentTypesCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersEnvironmentTypesCreateOrUpdate#Create)|[Example](#ExamplesEnvironmentTypesCreateOrUpdate#Create)| -|[az devcenter environment-type update](#EnvironmentTypesUpdate)|Update|[Parameters](#ParametersEnvironmentTypesUpdate)|[Example](#ExamplesEnvironmentTypesUpdate)| -|[az devcenter environment-type delete](#EnvironmentTypesDelete)|Delete|[Parameters](#ParametersEnvironmentTypesDelete)|[Example](#ExamplesEnvironmentTypesDelete)| - -### Commands in `az devcenter gallery` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter gallery list](#GalleriesListByDevCenter)|ListByDevCenter|[Parameters](#ParametersGalleriesListByDevCenter)|[Example](#ExamplesGalleriesListByDevCenter)| -|[az devcenter gallery show](#GalleriesGet)|Get|[Parameters](#ParametersGalleriesGet)|[Example](#ExamplesGalleriesGet)| -|[az devcenter gallery create](#GalleriesCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersGalleriesCreateOrUpdate#Create)|[Example](#ExamplesGalleriesCreateOrUpdate#Create)| -|[az devcenter gallery update](#GalleriesCreateOrUpdate#Update)|CreateOrUpdate#Update|[Parameters](#ParametersGalleriesCreateOrUpdate#Update)|Not Found| -|[az devcenter gallery delete](#GalleriesDelete)|Delete|[Parameters](#ParametersGalleriesDelete)|[Example](#ExamplesGalleriesDelete)| - -### Commands in `az devcenter image` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter image list](#ImagesListByGallery)|ListByGallery|[Parameters](#ParametersImagesListByGallery)|[Example](#ExamplesImagesListByGallery)| -|[az devcenter image list](#ImagesListByDevCenter)|ListByDevCenter|[Parameters](#ParametersImagesListByDevCenter)|[Example](#ExamplesImagesListByDevCenter)| -|[az devcenter image show](#ImagesGet)|Get|[Parameters](#ParametersImagesGet)|[Example](#ExamplesImagesGet)| - -### Commands in `az devcenter image-version` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter image-version list](#ImageVersionsListByImage)|ListByImage|[Parameters](#ParametersImageVersionsListByImage)|[Example](#ExamplesImageVersionsListByImage)| -|[az devcenter image-version show](#ImageVersionsGet)|Get|[Parameters](#ParametersImageVersionsGet)|[Example](#ExamplesImageVersionsGet)| - -### Commands in `az devcenter network-connection` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter network-connection list](#NetworkConnectionsListByResourceGroup)|ListByResourceGroup|[Parameters](#ParametersNetworkConnectionsListByResourceGroup)|[Example](#ExamplesNetworkConnectionsListByResourceGroup)| -|[az devcenter network-connection list](#NetworkConnectionsListBySubscription)|ListBySubscription|[Parameters](#ParametersNetworkConnectionsListBySubscription)|[Example](#ExamplesNetworkConnectionsListBySubscription)| -|[az devcenter network-connection show](#NetworkConnectionsGet)|Get|[Parameters](#ParametersNetworkConnectionsGet)|[Example](#ExamplesNetworkConnectionsGet)| -|[az devcenter network-connection create](#NetworkConnectionsCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersNetworkConnectionsCreateOrUpdate#Create)|[Example](#ExamplesNetworkConnectionsCreateOrUpdate#Create)| -|[az devcenter network-connection update](#NetworkConnectionsUpdate)|Update|[Parameters](#ParametersNetworkConnectionsUpdate)|[Example](#ExamplesNetworkConnectionsUpdate)| -|[az devcenter network-connection delete](#NetworkConnectionsDelete)|Delete|[Parameters](#ParametersNetworkConnectionsDelete)|[Example](#ExamplesNetworkConnectionsDelete)| -|[az devcenter network-connection list-health-detail](#NetworkConnectionsListHealthDetails)|ListHealthDetails|[Parameters](#ParametersNetworkConnectionsListHealthDetails)|[Example](#ExamplesNetworkConnectionsListHealthDetails)| -|[az devcenter network-connection run-health-check](#NetworkConnectionsRunHealthChecks)|RunHealthChecks|[Parameters](#ParametersNetworkConnectionsRunHealthChecks)|[Example](#ExamplesNetworkConnectionsRunHealthChecks)| -|[az devcenter network-connection show-health-detail](#NetworkConnectionsGetHealthDetails)|GetHealthDetails|[Parameters](#ParametersNetworkConnectionsGetHealthDetails)|[Example](#ExamplesNetworkConnectionsGetHealthDetails)| - -### Commands in `az devcenter operation-statuses` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter operation-statuses show](#OperationStatusesGet)|Get|[Parameters](#ParametersOperationStatusesGet)|[Example](#ExamplesOperationStatusesGet)| - -### Commands in `az devcenter pool` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter pool list](#PoolsListByProject)|ListByProject|[Parameters](#ParametersPoolsListByProject)|[Example](#ExamplesPoolsListByProject)| -|[az devcenter pool show](#PoolsGet)|Get|[Parameters](#ParametersPoolsGet)|[Example](#ExamplesPoolsGet)| -|[az devcenter pool create](#PoolsCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersPoolsCreateOrUpdate#Create)|[Example](#ExamplesPoolsCreateOrUpdate#Create)| -|[az devcenter pool update](#PoolsUpdate)|Update|[Parameters](#ParametersPoolsUpdate)|[Example](#ExamplesPoolsUpdate)| -|[az devcenter pool delete](#PoolsDelete)|Delete|[Parameters](#ParametersPoolsDelete)|[Example](#ExamplesPoolsDelete)| - -### Commands in `az devcenter project` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter project list](#ProjectsListByResourceGroup)|ListByResourceGroup|[Parameters](#ParametersProjectsListByResourceGroup)|[Example](#ExamplesProjectsListByResourceGroup)| -|[az devcenter project list](#ProjectsListBySubscription)|ListBySubscription|[Parameters](#ParametersProjectsListBySubscription)|[Example](#ExamplesProjectsListBySubscription)| -|[az devcenter project show](#ProjectsGet)|Get|[Parameters](#ParametersProjectsGet)|[Example](#ExamplesProjectsGet)| -|[az devcenter project create](#ProjectsCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersProjectsCreateOrUpdate#Create)|[Example](#ExamplesProjectsCreateOrUpdate#Create)| -|[az devcenter project update](#ProjectsUpdate)|Update|[Parameters](#ParametersProjectsUpdate)|[Example](#ExamplesProjectsUpdate)| -|[az devcenter project delete](#ProjectsDelete)|Delete|[Parameters](#ParametersProjectsDelete)|[Example](#ExamplesProjectsDelete)| - -### Commands in `az devcenter project-allowed-environment-type` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter project-allowed-environment-type list](#ProjectAllowedEnvironmentTypesList)|List|[Parameters](#ParametersProjectAllowedEnvironmentTypesList)|[Example](#ExamplesProjectAllowedEnvironmentTypesList)| -|[az devcenter project-allowed-environment-type show](#ProjectAllowedEnvironmentTypesGet)|Get|[Parameters](#ParametersProjectAllowedEnvironmentTypesGet)|[Example](#ExamplesProjectAllowedEnvironmentTypesGet)| - -### Commands in `az devcenter project-environment-type` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter project-environment-type list](#ProjectEnvironmentTypesList)|List|[Parameters](#ParametersProjectEnvironmentTypesList)|[Example](#ExamplesProjectEnvironmentTypesList)| -|[az devcenter project-environment-type show](#ProjectEnvironmentTypesGet)|Get|[Parameters](#ParametersProjectEnvironmentTypesGet)|[Example](#ExamplesProjectEnvironmentTypesGet)| -|[az devcenter project-environment-type create](#ProjectEnvironmentTypesCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersProjectEnvironmentTypesCreateOrUpdate#Create)|[Example](#ExamplesProjectEnvironmentTypesCreateOrUpdate#Create)| -|[az devcenter project-environment-type update](#ProjectEnvironmentTypesUpdate)|Update|[Parameters](#ParametersProjectEnvironmentTypesUpdate)|[Example](#ExamplesProjectEnvironmentTypesUpdate)| -|[az devcenter project-environment-type delete](#ProjectEnvironmentTypesDelete)|Delete|[Parameters](#ParametersProjectEnvironmentTypesDelete)|[Example](#ExamplesProjectEnvironmentTypesDelete)| - -### Commands in `az devcenter schedule` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter schedule list](#SchedulesListByPool)|ListByPool|[Parameters](#ParametersSchedulesListByPool)|[Example](#ExamplesSchedulesListByPool)| -|[az devcenter schedule show](#SchedulesGet)|Get|[Parameters](#ParametersSchedulesGet)|[Example](#ExamplesSchedulesGet)| -|[az devcenter schedule create](#SchedulesCreateOrUpdate#Create)|CreateOrUpdate#Create|[Parameters](#ParametersSchedulesCreateOrUpdate#Create)|[Example](#ExamplesSchedulesCreateOrUpdate#Create)| -|[az devcenter schedule update](#SchedulesUpdate)|Update|[Parameters](#ParametersSchedulesUpdate)|[Example](#ExamplesSchedulesUpdate)| -|[az devcenter schedule delete](#SchedulesDelete)|Delete|[Parameters](#ParametersSchedulesDelete)|[Example](#ExamplesSchedulesDelete)| - -### Commands in `az devcenter sku` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter sku list](#SkusListBySubscription)|ListBySubscription|[Parameters](#ParametersSkusListBySubscription)|[Example](#ExamplesSkusListBySubscription)| - -### Commands in `az devcenter usage` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter usage list](#UsagesListByLocation)|ListByLocation|[Parameters](#ParametersUsagesListByLocation)|[Example](#ExamplesUsagesListByLocation)| - - -## COMMAND DETAILS -### group `az devcenter attached-network` -#### Command `az devcenter attached-network list` - -##### Example -``` -az devcenter attached-network list --project-name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter attached-network list` - -##### Example -``` -az devcenter attached-network list --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter attached-network show` - -##### Example -``` -az devcenter attached-network show --attached-network-connection-name "network-uswest3" --project-name "DevProject" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--attached-network-connection-name**|string|The name of the attached NetworkConnection.|attached_network_connection_name|attachedNetworkConnectionName| - -#### Command `az devcenter attached-network show` - -##### Example -``` -az devcenter attached-network show --attached-network-connection-name "network-uswest3" --dev-center-name "Contoso" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--attached-network-connection-name**|string|The name of the attached NetworkConnection.|attached_network_connection_name|attachedNetworkConnectionName| - -#### Command `az devcenter attached-network create` - -##### Example -``` -az devcenter attached-network create --attached-network-connection-name "network-uswest3" --network-connection-id \ -"/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections\ -/network-uswest3" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--attached-network-connection-name**|string|The name of the attached NetworkConnection.|attached_network_connection_name|attachedNetworkConnectionName| -|**--network-connection-id**|string|The resource ID of the NetworkConnection you want to attach.|network_connection_id|networkConnectionId| - -#### Command `az devcenter attached-network update` - - -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--attached-network-connection-name**|string|The name of the attached NetworkConnection.|attached_network_connection_name|attachedNetworkConnectionName| -|**--network-connection-id**|string|The resource ID of the NetworkConnection you want to attach.|network_connection_id|networkConnectionId| - -#### Command `az devcenter attached-network delete` - -##### Example -``` -az devcenter attached-network delete --attached-network-connection-name "network-uswest3" --dev-center-name "Contoso" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--attached-network-connection-name**|string|The name of the attached NetworkConnection.|attached_network_connection_name|attachedNetworkConnectionName| - -### group `az devcenter catalog` -#### Command `az devcenter catalog list` - -##### Example -``` -az devcenter catalog list --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter catalog show` - -##### Example -``` -az devcenter catalog show --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--catalog-name**|string|The name of the Catalog.|catalog_name|catalogName| - -#### Command `az devcenter catalog create` - -##### Example -``` -az devcenter catalog create --ado-git path="/templates" branch="main" secret-identifier="https://contosokv.vault.azure.\ -net/secrets/CentralRepoPat" uri="https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso" --name \ -"CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1" -az devcenter catalog create --git-hub path="/templates" branch="main" secret-identifier="https://contosokv.vault.azure.\ -net/secrets/CentralRepoPat" uri="https://github.com/Contoso/centralrepo-fake.git" --name "CentralCatalog" \ ---dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--catalog-name**|string|The name of the Catalog.|catalog_name|catalogName| -|**--git-hub**|object|Properties for a GitHub catalog type.|git_hub|gitHub| -|**--ado-git**|object|Properties for an Azure DevOps catalog type.|ado_git|adoGit| - -#### Command `az devcenter catalog update` - -##### Example -``` -az devcenter catalog update --git-hub path="/environments" --name "CentralCatalog" --dev-center-name "Contoso" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--catalog-name**|string|The name of the Catalog.|catalog_name|catalogName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--git-hub**|object|Properties for a GitHub catalog type.|git_hub|gitHub| -|**--ado-git**|object|Properties for an Azure DevOps catalog type.|ado_git|adoGit| - -#### Command `az devcenter catalog delete` - -##### Example -``` -az devcenter catalog delete --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--catalog-name**|string|The name of the Catalog.|catalog_name|catalogName| - -#### Command `az devcenter catalog sync` - -##### Example -``` -az devcenter catalog sync --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--catalog-name**|string|The name of the Catalog.|catalog_name|catalogName| - -### group `az devcenter check-name-availability` -#### Command `az devcenter check-name-availability execute` - -##### Example -``` -az devcenter check-name-availability execute --name "name1" --type "Microsoft.DevCenter/devcenters" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--name**|string|The name of the resource for which availability needs to be checked.|name|name| -|**--type**|string|The resource type.|type|type| - -### group `az devcenter dev-box-definition` -#### Command `az devcenter dev-box-definition list` - -##### Example -``` -az devcenter dev-box-definition list --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter dev-box-definition list` - -##### Example -``` -az devcenter dev-box-definition list --project-name "ContosoProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter dev-box-definition show` - -##### Example -``` -az devcenter dev-box-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--dev-box-definition-name**|string|The name of the Dev Box definition.|dev_box_definition_name|devBoxDefinitionName| - -#### Command `az devcenter dev-box-definition show` - -##### Example -``` -az devcenter dev-box-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--dev-box-definition-name**|string|The name of the Dev Box definition.|dev_box_definition_name|devBoxDefinitionName| - -#### Command `az devcenter dev-box-definition create` - -##### Example -``` -az devcenter dev-box-definition create --location "centralus" --hibernate-support "Enabled" --image-reference \ -id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/\ -Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "SSD_1024" --sku name="Preview" \ ---name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--dev-box-definition-name**|string|The name of the Dev Box definition.|dev_box_definition_name|devBoxDefinitionName| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--image-reference**|object|Image reference information.|image_reference|imageReference| -|**--sku**|object|The SKU for Dev Boxes created using this definition.|sku|sku| -|**--os-storage-type**|string|The storage type used for the Operating System disk of Dev Boxes created using this definition.|os_storage_type|osStorageType| -|**--hibernate-support**|choice|Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate|hibernate_support|hibernateSupport| - -#### Command `az devcenter dev-box-definition update` - -##### Example -``` -az devcenter dev-box-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourc\ -eGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2\ -.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--dev-box-definition-name**|string|The name of the Dev Box definition.|dev_box_definition_name|devBoxDefinitionName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--image-reference**|object|Image reference information.|image_reference|imageReference| -|**--sku**|object|The SKU for Dev Boxes created using this definition.|sku|sku| -|**--os-storage-type**|string|The storage type used for the Operating System disk of Dev Boxes created using this definition.|os_storage_type|osStorageType| -|**--hibernate-support**|choice|Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate|hibernate_support|hibernateSupport| - -#### Command `az devcenter dev-box-definition delete` - -##### Example -``` -az devcenter dev-box-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--dev-box-definition-name**|string|The name of the Dev Box definition.|dev_box_definition_name|devBoxDefinitionName| - -### group `az devcenter dev-center` -#### Command `az devcenter dev-center list` - -##### Example -``` -az devcenter dev-center list --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter dev-center list` - -##### Example -``` -az devcenter dev-center list -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter dev-center show` - -##### Example -``` -az devcenter dev-center show --name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| - -#### Command `az devcenter dev-center create` - -##### Example -``` -az devcenter dev-center create --location "centralus" --tags CostCode="12345" --name "Contoso" --resource-group "rg1" -az devcenter dev-center create --type "UserAssigned" --user-assigned-identities "{\\"/subscriptions/00000000-0000-0000-\ -0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1\ -\\":{}}" --location "centralus" --tags CostCode="12345" --name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--type**|choice|Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).|type|type| -|**--user-assigned-identities**|dictionary|The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.|user_assigned_identities|userAssignedIdentities| - -#### Command `az devcenter dev-center update` - -##### Example -``` -az devcenter dev-center update --tags CostCode="12345" --name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--type**|choice|Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).|type|type| -|**--user-assigned-identities**|dictionary|The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.|user_assigned_identities|userAssignedIdentities| - -#### Command `az devcenter dev-center delete` - -##### Example -``` -az devcenter dev-center delete --name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| - -### group `az devcenter environment-type` -#### Command `az devcenter environment-type list` - -##### Example -``` -az devcenter environment-type list --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter environment-type show` - -##### Example -``` -az devcenter environment-type show --dev-center-name "Contoso" --name "DevTest" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| - -#### Command `az devcenter environment-type create` - -##### Example -``` -az devcenter environment-type create --tags Owner="superuser" --dev-center-name "Contoso" --name "DevTest" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| -|**--tags**|dictionary|Resource tags.|tags|tags| - -#### Command `az devcenter environment-type update` - -##### Example -``` -az devcenter environment-type update --tags Owner="superuser" --dev-center-name "Contoso" --name "DevTest" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| -|**--tags**|dictionary|Resource tags.|tags|tags| - -#### Command `az devcenter environment-type delete` - -##### Example -``` -az devcenter environment-type delete --dev-center-name "Contoso" --name "DevTest" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| - -### group `az devcenter gallery` -#### Command `az devcenter gallery list` - -##### Example -``` -az devcenter gallery list --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter gallery show` - -##### Example -``` -az devcenter gallery show --dev-center-name "Contoso" --name "StandardGallery" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| - -#### Command `az devcenter gallery create` - -##### Example -``` -az devcenter gallery create --gallery-resource-id "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg\ -1/providers/Microsoft.Compute/galleries/StandardGallery" --dev-center-name "Contoso" --name "StandardGallery" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| -|**--gallery-resource-id**|string|The resource ID of the backing Azure Compute Gallery.|gallery_resource_id|galleryResourceId| - -#### Command `az devcenter gallery update` - - -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| -|**--gallery-resource-id**|string|The resource ID of the backing Azure Compute Gallery.|gallery_resource_id|galleryResourceId| - -#### Command `az devcenter gallery delete` - -##### Example -``` -az devcenter gallery delete --dev-center-name "Contoso" --name "StandardGallery" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| - -### group `az devcenter image` -#### Command `az devcenter image list` - -##### Example -``` -az devcenter image list --dev-center-name "Contoso" --gallery-name "DevGallery" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter image list` - -##### Example -``` -az devcenter image list --dev-center-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter image show` - -##### Example -``` -az devcenter image show --dev-center-name "Contoso" --gallery-name "DefaultDevGallery" --name "ContosoBaseImage" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| -|**--image-name**|string|The name of the image.|image_name|imageName| - -### group `az devcenter image-version` -#### Command `az devcenter image-version list` - -##### Example -``` -az devcenter image-version list --dev-center-name "Contoso" --gallery-name "DefaultDevGallery" --image-name "Win11" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| -|**--image-name**|string|The name of the image.|image_name|imageName| - -#### Command `az devcenter image-version show` - -##### Example -``` -az devcenter image-version show --dev-center-name "Contoso" --gallery-name "DefaultDevGallery" --image-name "Win11" \ ---resource-group "rg1" --version-name "1.0.0" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--dev-center-name**|string|The name of the devcenter.|dev_center_name|devCenterName| -|**--gallery-name**|string|The name of the gallery.|gallery_name|galleryName| -|**--image-name**|string|The name of the image.|image_name|imageName| -|**--version-name**|string|The version of the image.|version_name|versionName| - -### group `az devcenter network-connection` -#### Command `az devcenter network-connection list` - -##### Example -``` -az devcenter network-connection list --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter network-connection list` - -##### Example -``` -az devcenter network-connection list -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter network-connection show` - -##### Example -``` -az devcenter network-connection show --name "uswest3network" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| - -#### Command `az devcenter network-connection create` - -##### Example -``` -az devcenter network-connection create --location "centralus" --domain-join-type "HybridAzureADJoin" --domain-name \ -"mydomaincontroller.local" --domain-password "Password value for user" --domain-username \ -"testuser@mydomaincontroller.local" --networking-resource-group-name "NetworkInterfaces" --subnet-id \ -"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetwor\ -ks/ExampleVNet/subnets/default" --name "uswest3network" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--subnet-id**|string|The subnet to attach Virtual Machines to|subnet_id|subnetId| -|**--domain-name**|string|Active Directory domain name|domain_name|domainName| -|**--organization-unit**|string|Active Directory domain Organization Unit (OU)|organization_unit|organizationUnit| -|**--domain-username**|string|The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.|domain_username|domainUsername| -|**--domain-password**|string|The password for the account used to join domain|domain_password|domainPassword| -|**--networking-resource-group-name**|string|The name for resource group where NICs will be placed.|networking_resource_group_name|networkingResourceGroupName| -|**--domain-join-type**|choice|AAD Join type.|domain_join_type|domainJoinType| - -#### Command `az devcenter network-connection update` - -##### Example -``` -az devcenter network-connection update --domain-password "New Password value for user" --name "uswest3network" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--subnet-id**|string|The subnet to attach Virtual Machines to|subnet_id|subnetId| -|**--domain-name**|string|Active Directory domain name|domain_name|domainName| -|**--organization-unit**|string|Active Directory domain Organization Unit (OU)|organization_unit|organizationUnit| -|**--domain-username**|string|The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.|domain_username|domainUsername| -|**--domain-password**|string|The password for the account used to join domain|domain_password|domainPassword| - -#### Command `az devcenter network-connection delete` - -##### Example -``` -az devcenter network-connection delete --name "eastusnetwork" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| - -#### Command `az devcenter network-connection list-health-detail` - -##### Example -``` -az devcenter network-connection list-health-detail --name "uswest3network" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| - -#### Command `az devcenter network-connection run-health-check` - -##### Example -``` -az devcenter network-connection run-health-check --name "uswest3network" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| - -#### Command `az devcenter network-connection show-health-detail` - -##### Example -``` -az devcenter network-connection show-health-detail --name "eastusnetwork" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--network-connection-name**|string|Name of the Network Connection that can be applied to a Pool.|network_connection_name|networkConnectionName| - -### group `az devcenter operation-statuses` -#### Command `az devcenter operation-statuses show` - -##### Example -``` -az devcenter operation-statuses show --operation-id "3fa1a29d-e807-488d-81d1-f1c5456a08cd" --location "westus3" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--location**|string|The Azure region|location|location| -|**--operation-id**|string|The ID of an ongoing async operation|operation_id|operationId| - -### group `az devcenter pool` -#### Command `az devcenter pool list` - -##### Example -``` -az devcenter pool list --project-name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter pool show` - -##### Example -``` -az devcenter pool show --name "DevPool" --project-name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| - -#### Command `az devcenter pool create` - -##### Example -``` -az devcenter pool create --location "centralus" --dev-box-definition-name "WebDevBox" --local-administrator "Enabled" \ ---network-connection-name "Network1-westus2" --name "DevPool" --project-name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--dev-box-definition-name**|string|Name of a Dev Box definition in parent Project of this Pool|dev_box_definition_name|devBoxDefinitionName| -|**--network-connection-name**|string|Name of a Network Connection in parent Project of this Pool|network_connection_name|networkConnectionName| -|**--local-administrator**|choice|Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.|local_administrator|localAdministrator| - -#### Command `az devcenter pool update` - -##### Example -``` -az devcenter pool update --dev-box-definition-name "WebDevBox2" --name "DevPool" --project-name "DevProject" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--dev-box-definition-name**|string|Name of a Dev Box definition in parent Project of this Pool|dev_box_definition_name|devBoxDefinitionName| -|**--network-connection-name**|string|Name of a Network Connection in parent Project of this Pool|network_connection_name|networkConnectionName| -|**--local-administrator**|choice|Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.|local_administrator|localAdministrator| - -#### Command `az devcenter pool delete` - -##### Example -``` -az devcenter pool delete --name "poolName" --project-name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| - -### group `az devcenter project` -#### Command `az devcenter project list` - -##### Example -``` -az devcenter project list --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter project list` - -##### Example -``` -az devcenter project list -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter project show` - -##### Example -``` -az devcenter project show --name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| - -#### Command `az devcenter project create` - -##### Example -``` -az devcenter project create --location "centralus" --description "This is my first project." --dev-center-id \ -"/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso\ -" --tags CostCenter="R&D" --name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--dev-center-id**|string|Resource Id of an associated DevCenter|dev_center_id|devCenterId| -|**--description**|string|Description of the project.|description|description| - -#### Command `az devcenter project update` - -##### Example -``` -az devcenter project update --description "This is my first project." --tags CostCenter="R&D" --name "DevProject" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--dev-center-id**|string|Resource Id of an associated DevCenter|dev_center_id|devCenterId| -|**--description**|string|Description of the project.|description|description| - -#### Command `az devcenter project delete` - -##### Example -``` -az devcenter project delete --name "DevProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| - -### group `az devcenter project-allowed-environment-type` -#### Command `az devcenter project-allowed-environment-type list` - -##### Example -``` -az devcenter project-allowed-environment-type list --project-name "Contoso" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter project-allowed-environment-type show` - -##### Example -``` -az devcenter project-allowed-environment-type show --environment-type-name "DevTest" --project-name "Contoso" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| - -### group `az devcenter project-environment-type` -#### Command `az devcenter project-environment-type list` - -##### Example -``` -az devcenter project-environment-type list --project-name "ContosoProj" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter project-environment-type show` - -##### Example -``` -az devcenter project-environment-type show --environment-type-name "DevTest" --project-name "ContosoProj" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| - -#### Command `az devcenter project-environment-type create` - -##### Example -``` -az devcenter project-environment-type create --type "UserAssigned" --user-assigned-identities \ -"{\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdenti\ -ty/userAssignedIdentities/testidentity1\\":{}}" --roles "{\\"4cbf0b6c-e750-441c-98a7-10da8387e4d6\\":{}}" \ ---deployment-target-id "/subscriptions/00000000-0000-0000-0000-000000000000" --status "Enabled" \ ---user-role-assignments "{\\"e45e3m7c-176e-416a-b466-0c5ec8298f8a\\":{\\"roles\\":{\\"4cbf0b6c-e750-441c-98a7-10da8387e\ -4d6\\":{}}}}" --tags CostCenter="RnD" --environment-type-name "DevTest" --project-name "ContosoProj" --resource-group \ -"rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location for the environment type|location|location| -|**--deployment-target-id**|string|Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.|deployment_target_id|deploymentTargetId| -|**--status**|choice|Defines whether this Environment Type can be used in this Project.|status|status| -|**--user-role-assignments**|dictionary|Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.|user_role_assignments|userRoleAssignments| -|**--roles**|dictionary|A map of roles to assign to the environment creator.|roles|roles| -|**--type**|choice|Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).|type|type| -|**--user-assigned-identities**|dictionary|The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.|user_assigned_identities|userAssignedIdentities| - -#### Command `az devcenter project-environment-type update` - -##### Example -``` -az devcenter project-environment-type update --type "UserAssigned" --user-assigned-identities \ -"{\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdenti\ -ty/userAssignedIdentities/testidentity1\\":{}}" --deployment-target-id "/subscriptions/00000000-0000-0000-0000-00000000\ -0000" --status "Enabled" --user-role-assignments "{\\"e45e3m7c-176e-416a-b466-0c5ec8298f8a\\":{\\"roles\\":{\\"4cbf0b6c\ --e750-441c-98a7-10da8387e4d6\\":{}}}}" --tags CostCenter="RnD" --environment-type-name "DevTest" --project-name \ -"ContosoProj" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--deployment-target-id**|string|Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.|deployment_target_id|deploymentTargetId| -|**--status**|choice|Defines whether this Environment Type can be used in this Project.|status|status| -|**--user-role-assignments**|dictionary|Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.|user_role_assignments|userRoleAssignments| -|**--roles**|dictionary|A map of roles to assign to the environment creator.|roles|roles| -|**--type**|choice|Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).|type|type| -|**--user-assigned-identities**|dictionary|The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.|user_assigned_identities|userAssignedIdentities| - -#### Command `az devcenter project-environment-type delete` - -##### Example -``` -az devcenter project-environment-type delete --environment-type-name "DevTest" --project-name "ContosoProj" \ ---resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--environment-type-name**|string|The name of the environment type.|environment_type_name|environmentTypeName| - -### group `az devcenter schedule` -#### Command `az devcenter schedule list` - -##### Example -``` -az devcenter schedule list --pool-name "DevPool" --project-name "TestProject" --resource-group "rg1" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter schedule show` - -##### Example -``` -az devcenter schedule show --pool-name "DevPool" --project-name "TestProject" --resource-group "rg1" --name \ -"autoShutdown" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--schedule-name**|string|The name of the schedule that uniquely identifies it.|schedule_name|scheduleName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -#### Command `az devcenter schedule create` - -##### Example -``` -az devcenter schedule create --state "Enabled" --time "17:30" --time-zone "America/Los_Angeles" --pool-name "DevPool" \ ---project-name "DevProject" --resource-group "rg1" --name "autoShutdown" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--schedule-name**|string|The name of the schedule that uniquely identifies it.|schedule_name|scheduleName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| -|**--time**|string|The target time to trigger the action. The format is HH:MM.|time|time| -|**--time-zone**|string|The IANA timezone id at which the schedule should execute.|time_zone|timeZone| -|**--state**|choice|Indicates whether or not this scheduled task is enabled.|state|state| - -#### Command `az devcenter schedule update` - -##### Example -``` -az devcenter schedule update --time "18:00" --pool-name "DevPool" --project-name "TestProject" --resource-group "rg1" \ ---name "autoShutdown" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--schedule-name**|string|The name of the schedule that uniquely identifies it.|schedule_name|scheduleName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| -|**--tags**|dictionary|Resource tags.|tags|tags| -|**--location**|string|The geo-location where the resource lives|location|location| -|**--time**|string|The target time to trigger the action. The format is HH:MM.|time|time| -|**--time-zone**|string|The IANA timezone id at which the schedule should execute.|time_zone|timeZone| -|**--state**|choice|Indicates whether or not this scheduled task is enabled.|state|state| - -#### Command `az devcenter schedule delete` - -##### Example -``` -az devcenter schedule delete --pool-name "DevPool" --project-name "TestProject" --resource-group "rg1" --name \ -"autoShutdown" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--resource-group-name**|string|The name of the resource group. The name is case insensitive.|resource_group_name|resourceGroupName| -|**--project-name**|string|The name of the project.|project_name|projectName| -|**--pool-name**|string|Name of the pool.|pool_name|poolName| -|**--schedule-name**|string|The name of the schedule that uniquely identifies it.|schedule_name|scheduleName| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -### group `az devcenter sku` -#### Command `az devcenter sku list` - -##### Example -``` -az devcenter sku list -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: '$top=10'.|top|$top| - -### group `az devcenter usage` -#### Command `az devcenter usage list` - -##### Example -``` -az devcenter usage list --location "westus" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--location**|string|The Azure region|location|location| - -##Dataplane commands -## GROUPS -### Command groups in `az devcenter` extension -|CLI Command Group|Group Swagger name|Commands| -|---------|------------|--------| -|az devcenter dev-box|DevBoxes|[commands](#CommandsInDevBoxes)| -|az devcenter dev-center|DevCenter|[commands](#CommandsInDevCenter)| -|az devcenter environment|Environments|[commands](#CommandsInEnvironments)| - -## COMMANDS -### Commands in `az devcenter dev-box` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter dev-box create-dev-box](#DevBoxesCreateDevBox)|CreateDevBox|[Parameters](#ParametersDevBoxesCreateDevBox)|[Example](#ExamplesDevBoxesCreateDevBox)| -|[az devcenter dev-box delay-upcoming-action](#DevBoxesDelayUpcomingAction)|DelayUpcomingAction|[Parameters](#ParametersDevBoxesDelayUpcomingAction)|[Example](#ExamplesDevBoxesDelayUpcomingAction)| -|[az devcenter dev-box delete-dev-box](#DevBoxesDeleteDevBox)|DeleteDevBox|[Parameters](#ParametersDevBoxesDeleteDevBox)|[Example](#ExamplesDevBoxesDeleteDevBox)| -|[az devcenter dev-box list-dev-box](#DevBoxesListDevBoxesByUser)|ListDevBoxesByUser|[Parameters](#ParametersDevBoxesListDevBoxesByUser)|[Example](#ExamplesDevBoxesListDevBoxesByUser)| -|[az devcenter dev-box list-pool](#DevBoxesListPools)|ListPools|[Parameters](#ParametersDevBoxesListPools)|[Example](#ExamplesDevBoxesListPools)| -|[az devcenter dev-box list-schedule](#DevBoxesListSchedulesByPool)|ListSchedulesByPool|[Parameters](#ParametersDevBoxesListSchedulesByPool)|[Example](#ExamplesDevBoxesListSchedulesByPool)| -|[az devcenter dev-box list-upcoming-action](#DevBoxesListUpcomingActions)|ListUpcomingActions|[Parameters](#ParametersDevBoxesListUpcomingActions)|[Example](#ExamplesDevBoxesListUpcomingActions)| -|[az devcenter dev-box show-dev-box](#DevBoxesGetDevBoxByUser)|GetDevBoxByUser|[Parameters](#ParametersDevBoxesGetDevBoxByUser)|[Example](#ExamplesDevBoxesGetDevBoxByUser)| -|[az devcenter dev-box show-pool](#DevBoxesGetPool)|GetPool|[Parameters](#ParametersDevBoxesGetPool)|[Example](#ExamplesDevBoxesGetPool)| -|[az devcenter dev-box show-remote-connection](#DevBoxesGetRemoteConnection)|GetRemoteConnection|[Parameters](#ParametersDevBoxesGetRemoteConnection)|[Example](#ExamplesDevBoxesGetRemoteConnection)| -|[az devcenter dev-box show-schedule](#DevBoxesGetScheduleByPool)|GetScheduleByPool|[Parameters](#ParametersDevBoxesGetScheduleByPool)|[Example](#ExamplesDevBoxesGetScheduleByPool)| -|[az devcenter dev-box show-upcoming-action](#DevBoxesGetUpcomingAction)|GetUpcomingAction|[Parameters](#ParametersDevBoxesGetUpcomingAction)|[Example](#ExamplesDevBoxesGetUpcomingAction)| -|[az devcenter dev-box skip-upcoming-action](#DevBoxesSkipUpcomingAction)|SkipUpcomingAction|[Parameters](#ParametersDevBoxesSkipUpcomingAction)|[Example](#ExamplesDevBoxesSkipUpcomingAction)| -|[az devcenter dev-box start-dev-box](#DevBoxesStartDevBox)|StartDevBox|[Parameters](#ParametersDevBoxesStartDevBox)|[Example](#ExamplesDevBoxesStartDevBox)| -|[az devcenter dev-box stop-dev-box](#DevBoxesStopDevBox)|StopDevBox|[Parameters](#ParametersDevBoxesStopDevBox)|[Example](#ExamplesDevBoxesStopDevBox)| - -### Commands in `az devcenter dev-center` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter dev-center create-notification-setting](#DevCenterCreateNotificationSettings)|CreateNotificationSettings|[Parameters](#ParametersDevCenterCreateNotificationSettings)|[Example](#ExamplesDevCenterCreateNotificationSettings)| -|[az devcenter dev-center list-all-dev-box](#DevCenterListAllDevBoxesByUser)|ListAllDevBoxesByUser|[Parameters](#ParametersDevCenterListAllDevBoxesByUser)|[Example](#ExamplesDevCenterListAllDevBoxesByUser)| -|[az devcenter dev-center list-all-dev-box](#DevCenterListAllDevBoxes)|ListAllDevBoxes|[Parameters](#ParametersDevCenterListAllDevBoxes)|[Example](#ExamplesDevCenterListAllDevBoxes)| -|[az devcenter dev-center list-notification-setting-allowed-culture](#DevCenterListNotificationSettingsAllowedCultures)|ListNotificationSettingsAllowedCultures|[Parameters](#ParametersDevCenterListNotificationSettingsAllowedCultures)|[Example](#ExamplesDevCenterListNotificationSettingsAllowedCultures)| -|[az devcenter dev-center list-project](#DevCenterListProjects)|ListProjects|[Parameters](#ParametersDevCenterListProjects)|[Example](#ExamplesDevCenterListProjects)| -|[az devcenter dev-center show-notification-setting](#DevCenterGetNotificationSettings)|GetNotificationSettings|[Parameters](#ParametersDevCenterGetNotificationSettings)|[Example](#ExamplesDevCenterGetNotificationSettings)| -|[az devcenter dev-center show-project](#DevCenterGetProject)|GetProject|[Parameters](#ParametersDevCenterGetProject)|[Example](#ExamplesDevCenterGetProject)| - -### Commands in `az devcenter environment` group -|CLI Command|Operation Swagger name|Parameters|Examples| -|---------|------------|--------|-----------| -|[az devcenter environment create-or-update-environment](#EnvironmentsCreateOrUpdateEnvironment)|CreateOrUpdateEnvironment|[Parameters](#ParametersEnvironmentsCreateOrUpdateEnvironment)|[Example](#ExamplesEnvironmentsCreateOrUpdateEnvironment)| -|[az devcenter environment custom-environment-action](#EnvironmentsCustomEnvironmentAction)|CustomEnvironmentAction|[Parameters](#ParametersEnvironmentsCustomEnvironmentAction)|[Example](#ExamplesEnvironmentsCustomEnvironmentAction)| -|[az devcenter environment delete-environment](#EnvironmentsDeleteEnvironment)|DeleteEnvironment|[Parameters](#ParametersEnvironmentsDeleteEnvironment)|[Example](#ExamplesEnvironmentsDeleteEnvironment)| -|[az devcenter environment deploy-environment-action](#EnvironmentsDeployEnvironmentAction)|DeployEnvironmentAction|[Parameters](#ParametersEnvironmentsDeployEnvironmentAction)|[Example](#ExamplesEnvironmentsDeployEnvironmentAction)| -|[az devcenter environment list-artifact](#EnvironmentsListArtifactsByEnvironmentAndPath)|ListArtifactsByEnvironmentAndPath|[Parameters](#ParametersEnvironmentsListArtifactsByEnvironmentAndPath)|Not Found| -|[az devcenter environment list-artifact](#EnvironmentsListArtifactsByEnvironment)|ListArtifactsByEnvironment|[Parameters](#ParametersEnvironmentsListArtifactsByEnvironment)|Not Found| -|[az devcenter environment list-catalog-item](#EnvironmentsListCatalogItems)|ListCatalogItems|[Parameters](#ParametersEnvironmentsListCatalogItems)|[Example](#ExamplesEnvironmentsListCatalogItems)| -|[az devcenter environment list-catalog-item-version](#EnvironmentsListCatalogItemVersions)|ListCatalogItemVersions|[Parameters](#ParametersEnvironmentsListCatalogItemVersions)|[Example](#ExamplesEnvironmentsListCatalogItemVersions)| -|[az devcenter environment list-environment](#EnvironmentsListEnvironmentsByUser)|ListEnvironmentsByUser|[Parameters](#ParametersEnvironmentsListEnvironmentsByUser)|[Example](#ExamplesEnvironmentsListEnvironmentsByUser)| -|[az devcenter environment list-environment](#EnvironmentsListEnvironments)|ListEnvironments|[Parameters](#ParametersEnvironmentsListEnvironments)|[Example](#ExamplesEnvironmentsListEnvironments)| -|[az devcenter environment list-environment-type](#EnvironmentsListEnvironmentTypes)|ListEnvironmentTypes|[Parameters](#ParametersEnvironmentsListEnvironmentTypes)|[Example](#ExamplesEnvironmentsListEnvironmentTypes)| -|[az devcenter environment show-catalog-item](#EnvironmentsGetCatalogItem)|GetCatalogItem|[Parameters](#ParametersEnvironmentsGetCatalogItem)|[Example](#ExamplesEnvironmentsGetCatalogItem)| -|[az devcenter environment show-catalog-item-version](#EnvironmentsGetCatalogItemVersion)|GetCatalogItemVersion|[Parameters](#ParametersEnvironmentsGetCatalogItemVersion)|[Example](#ExamplesEnvironmentsGetCatalogItemVersion)| -|[az devcenter environment show-environment](#EnvironmentsGetEnvironmentByUser)|GetEnvironmentByUser|[Parameters](#ParametersEnvironmentsGetEnvironmentByUser)|[Example](#ExamplesEnvironmentsGetEnvironmentByUser)| -|[az devcenter environment update-environment](#EnvironmentsUpdateEnvironment)|UpdateEnvironment|[Parameters](#ParametersEnvironmentsUpdateEnvironment)|[Example](#ExamplesEnvironmentsUpdateEnvironment)| - - -## COMMAND DETAILS -### group `az devcenter dev-box` -#### Command `az devcenter dev-box create-dev-box` - -##### Example -``` -az devcenter dev-box create-dev-box --pool-name "LargeDevWorkStationPool" --name "MyDevBox" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| -|**--pool-name**|string|The name of the Dev Box pool this machine belongs to.|pool_name|poolName| -|**--local-administrator**|choice|Indicates whether the owner of the Dev Box is a local administrator.|local_administrator|localAdministrator| - -#### Command `az devcenter dev-box delay-upcoming-action` - -##### Example -``` -az devcenter dev-box delay-upcoming-action --delay-until "2022-09-30T17:00:00Z" --name "myDevBox" --upcoming-action-id \ -"cae4d1f4-94b8-75f2-406d-5f00ae4c1da7" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| -|**--upcoming-action-id**|string|The upcoming action id.|upcoming_action_id|upcomingActionId| -|**--delay-until**|date-time|The delayed action time (UTC).|delay_until|delayUntil| - -#### Command `az devcenter dev-box delete-dev-box` - -##### Example -``` -az devcenter dev-box delete-dev-box --name "MyDevBox" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| - -#### Command `az devcenter dev-box list-dev-box` - -##### Example -``` -az devcenter dev-box list-dev-box --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--filter**|string|An OData filter clause to apply to the operation.|filter|filter| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| - -#### Command `az devcenter dev-box list-pool` - -##### Example -``` -az devcenter dev-box list-pool -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| -|**--filter**|string|An OData filter clause to apply to the operation.|filter|filter| - -#### Command `az devcenter dev-box list-schedule` - -##### Example -``` -az devcenter dev-box list-schedule --pool-name "DevPool" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| -|**--filter**|string|An OData filter clause to apply to the operation.|filter|filter| -|**--pool-name**|string|The name of a pool of Dev Boxes.|pool_name|poolName| - -#### Command `az devcenter dev-box list-upcoming-action` - -##### Example -``` -az devcenter dev-box list-upcoming-action --name "myDevBox" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| - -#### Command `az devcenter dev-box show-dev-box` - -##### Example -``` -az devcenter dev-box show-dev-box --name "MyDevBox" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| - -#### Command `az devcenter dev-box show-pool` - -##### Example -``` -az devcenter dev-box show-pool --pool-name "DevPool" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--pool-name**|string|The name of a pool of Dev Boxes.|pool_name|poolName| - -#### Command `az devcenter dev-box show-remote-connection` - -##### Example -``` -az devcenter dev-box show-remote-connection --name "MyDevBox" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| - -#### Command `az devcenter dev-box show-schedule` - -##### Example -``` -az devcenter dev-box show-schedule --pool-name "DevPool" --schedule-name "default" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--pool-name**|string|The name of a pool of Dev Boxes.|pool_name|poolName| -|**--schedule-name**|string|The name of a schedule.|schedule_name|scheduleName| - -#### Command `az devcenter dev-box show-upcoming-action` - -##### Example -``` -az devcenter dev-box show-upcoming-action --name "myDevBox" --upcoming-action-id "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7"\ - --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| -|**--upcoming-action-id**|string|The upcoming action id.|upcoming_action_id|upcomingActionId| - -#### Command `az devcenter dev-box skip-upcoming-action` - -##### Example -``` -az devcenter dev-box skip-upcoming-action --name "myDevBox" --upcoming-action-id "cae4d1f4-94b8-75f2-406d-5f00ae4c1da7"\ - --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| -|**--upcoming-action-id**|string|The upcoming action id.|upcoming_action_id|upcomingActionId| - -#### Command `az devcenter dev-box start-dev-box` - -##### Example -``` -az devcenter dev-box start-dev-box --name "MyDevBox" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| - -#### Command `az devcenter dev-box stop-dev-box` - -##### Example -``` -az devcenter dev-box stop-dev-box --name "MyDevBox" --hibernate "true" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--dev-box-name**|string|The name of a Dev Box.|dev_box_name|devBoxName| -|**--hibernate**|boolean|Optional parameter to hibernate the dev box.|hibernate|hibernate| - -### group `az devcenter dev-center` -#### Command `az devcenter dev-center create-notification-setting` - -##### Example -``` -az devcenter dev-center create-notification-setting --culture "en-us" --enabled false --boolean-enabled true \ ---email-notification cc="stubcc@domain.com" enabled=true recipients="stubrecipient@domain.com" --webhook-notification \ -enabled=false url="https://fake.domain/url/hook" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--enabled**|boolean|If notification is enabled for the user.|enabled|enabled| -|**--culture**|string|The culture that MEO can accommdate requests to send emails in.|culture|culture| -|**--boolean-enabled**|boolean|If notification is enabled for DevBox provisioning.|boolean_enabled|enabled| -|**--email-notification**|object|The email notification|email_notification|emailNotification| -|**--webhook-notification**|object|The webhook notification|webhook_notification|webhookNotification| - -#### Command `az devcenter dev-center list-all-dev-box` - -##### Example -``` -az devcenter dev-center list-all-dev-box --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--filter**|string|An OData filter clause to apply to the operation.|filter|filter| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| - -#### Command `az devcenter dev-center list-all-dev-box` - -##### Example -``` -az devcenter dev-center list-all-dev-box -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--filter**|string|An OData filter clause to apply to the operation.|filter|filter| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| - -#### Command `az devcenter dev-center list-notification-setting-allowed-culture` - -##### Example -``` -az devcenter dev-center list-notification-setting-allowed-culture --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| - -#### Command `az devcenter dev-center list-project` - -##### Example -``` -az devcenter dev-center list-project -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--filter**|string|An OData filter clause to apply to the operation.|filter|filter| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| - -#### Command `az devcenter dev-center show-notification-setting` - -##### Example -``` -az devcenter dev-center show-notification-setting --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| - -#### Command `az devcenter dev-center show-project` - -##### Example -``` -az devcenter dev-center show-project --project-name "myProject" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--project-name**|string|The DevCenter Project upon which to execute operations.|project_name|projectName| - -### group `az devcenter environment` -#### Command `az devcenter environment create-or-update-environment` - -##### Example -``` -az devcenter environment create-or-update-environment --description "Personal Dev Environment" --catalog-item-name \ -"helloworld" --catalog-name "main" --environment-type "DevTest" --parameters "{\\"functionAppRuntime\\":\\"node\\",\\"s\ -torageAccountType\\":\\"Standard_LRS\\"}" --name "mydevenv" --user-id "me" -az devcenter environment create-or-update-environment --description "Personal Dev Environment" --catalog-item-name \ -"helloworld" --catalog-name "main" --environment-type "DevTest" --parameters "{\\"functionAppRuntime\\":\\"node\\",\\"s\ -torageAccountType\\":\\"Standard_LRS\\"}" --scheduled-tasks "{\\"autoExpire\\":{\\"type\\":\\"AutoExpire\\",\\"startTim\ -e\\":\\"2022-01-01T00:01:00Z\\"}}" --name "mydevenv" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| -|**--description**|string|Description of the Environment.|description|description| -|**--catalog-name**|string|Name of the catalog.|catalog_name|catalogName| -|**--catalog-item-name**|string|Name of the catalog item.|catalog_item_name|catalogItemName| -|**--parameters**|any|Parameters object for the deploy action|parameters|parameters| -|**--scheduled-tasks**|dictionary|Set of supported scheduled tasks to help manage cost.|scheduled_tasks|scheduledTasks| -|**--tags**|dictionary|Key value pairs that will be applied to resources deployed in this environment as tags.|tags|tags| -|**--environment-type**|string|Environment type.|environment_type|environmentType| -|**--user**|string|The AAD object id of the owner of this Environment.|user|user| - -#### Command `az devcenter environment custom-environment-action` - -##### Example -``` -az devcenter environment custom-environment-action --action-id "someCustomActionId" --parameters \ -"{\\"functionAppRuntime\\":\\"node\\",\\"storageAccountType\\":\\"Standard_LRS\\"}" --name "mydevenv" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| -|**--action-id**|string|The Catalog Item action id to execute|action_id|actionId| -|**--parameters**|any|Parameters object for the Action|parameters|parameters| - -#### Command `az devcenter environment delete-environment` - -##### Example -``` -az devcenter environment delete-environment --name "mydevenv" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| - -#### Command `az devcenter environment deploy-environment-action` - -##### Example -``` -az devcenter environment deploy-environment-action --action-id "deploy" --parameters "{\\"functionAppRuntime\\":\\"node\ -\\",\\"storageAccountType\\":\\"Standard_LRS\\"}" --name "mydevenv" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| -|**--action-id**|string|The Catalog Item action id to execute|action_id|actionId| -|**--parameters**|any|Parameters object for the Action|parameters|parameters| - -#### Command `az devcenter environment list-artifact` - - -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| -|**--artifact-path**|string|The path of the artifact.|artifact_path|artifactPath| - -#### Command `az devcenter environment list-artifact` - - -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| - -#### Command `az devcenter environment list-catalog-item` - -##### Example -``` -az devcenter environment list-catalog-item -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| - -#### Command `az devcenter environment list-catalog-item-version` - -##### Example -``` -az devcenter environment list-catalog-item-version --catalog-item-id "foo" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| -|**--catalog-item-id**|string|The unique id of the catalog item.|catalog_item_id|catalogItemId| - -#### Command `az devcenter environment list-environment` - -##### Example -``` -az devcenter environment list-environment --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| - -#### Command `az devcenter environment list-environment` - -##### Example -``` -az devcenter environment list-environment -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| - -#### Command `az devcenter environment list-environment-type` - -##### Example -``` -az devcenter environment list-environment-type -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--top**|integer|The maximum number of resources to return from the operation. Example: 'top=10'.|top|top| - -#### Command `az devcenter environment show-catalog-item` - -##### Example -``` -az devcenter environment show-catalog-item --catalog-item-id "foo" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--catalog-item-id**|string|The unique id of the catalog item.|catalog_item_id|catalogItemId| - -#### Command `az devcenter environment show-catalog-item-version` - -##### Example -``` -az devcenter environment show-catalog-item-version --catalog-item-id "foo" --version "1.0.0" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--catalog-item-id**|string|The unique id of the catalog item.|catalog_item_id|catalogItemId| -|**--version**|string|The version of the catalog item.|version|version| - -#### Command `az devcenter environment show-environment` - -##### Example -``` -az devcenter environment show-environment --name "mydevenv" --user-id "me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| - -#### Command `az devcenter environment update-environment` - -##### Example -``` -az devcenter environment update-environment --description "Personal Dev Environment 2" --name "mydevenv" --user-id \ -"me" -``` -##### Parameters -|Option|Type|Description|Path (SDK)|Swagger name| -|------|----|-----------|----------|------------| -|**--user-id**|string|The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.|user_id|userId| -|**--environment-name**|string|The name of the environment.|environment_name|environmentName| -|**--description**|string|Description of the Environment.|description|description| -|**--catalog-name**|string|Name of the catalog.|catalog_name|catalogName| -|**--catalog-item-name**|string|Name of the catalog item.|catalog_item_name|catalogItemName| -|**--parameters**|any|Parameters object for the deploy action|parameters|parameters| -|**--scheduled-tasks**|dictionary|Set of supported scheduled tasks to help manage cost.|scheduled_tasks|scheduledTasks| -|**--tags**|dictionary|Key value pairs that will be applied to resources deployed in this environment as tags.|tags|tags| diff --git a/src/devcenter/setup.py b/src/devcenter/setup.py index 90c91fb5743..45c95672685 100644 --- a/src/devcenter/setup.py +++ b/src/devcenter/setup.py @@ -10,7 +10,7 @@ from setuptools import setup, find_packages # HISTORY.rst entry. -VERSION = '0.1.0' +VERSION = '0.1.1' try: from azext_devcenter.manual.version import VERSION except ImportError: @@ -46,8 +46,8 @@ name='devcenter', version=VERSION, description='Microsoft Azure Command-Line Tools DevCenter Extension', - author='Microsoft Corporation', - author_email='azpycli@microsoft.com', + author='DevCenter', + author_email='tm-azurefidalgo@microsoft.com', url='https://github.com/Azure/azure-cli-extensions/tree/master/src/devcenter', long_description=README + '\n\n' + HISTORY, license='MIT',