DevCenterClient Class

DevCenterClient.

Constructor

DevCenterClient(endpoint: str, credential: TokenCredential, **kwargs: Any)

Parameters

Name	Description
endpoint Required	str The DevCenter-specific URI to operate on. Required.
credential Required	TokenCredential Credential used to authenticate requests to the service. Required.

Keyword-Only Parameters

Name	Description
api_version	str The API version to use for this operation. Default value is "2023-04-01". Note that overriding this default value may result in unsupported behavior.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Methods

begin_create_dev_box	Creates or replaces a Dev Box.
begin_create_or_update_environment	Creates or updates an environment.
begin_delete_dev_box	Deletes a Dev Box.
begin_delete_environment	Deletes an environment and all its associated resources.
begin_restart_dev_box	Restarts a Dev Box.
begin_start_dev_box	Starts a Dev Box.
begin_stop_dev_box	Stops a Dev Box.
close
delay_all_dev_box_actions	Delays all actions.
delay_dev_box_action	Delays the occurrence of an action.
get_catalog	Gets the specified catalog within the project.
get_dev_box	Gets a Dev Box.
get_dev_box_action	Gets an action.
get_environment	Gets an environment.
get_environment_definition	Get an environment definition from a catalog.
get_pool	Gets a pool.
get_project	Gets a project.
get_remote_connection	Gets RDP Connection info.
get_schedule	Gets a schedule.
list_all_dev_boxes	Lists Dev Boxes that the caller has access to in the DevCenter.
list_all_dev_boxes_by_user	Lists Dev Boxes in the Dev Center for a particular user.
list_all_environments	Lists the environments for a project.
list_catalogs	Lists all of the catalogs available for a project.
list_dev_box_actions	Lists actions on a Dev Box.
list_dev_boxes	Lists Dev Boxes in the project for a particular user.
list_environment_definitions	Lists all environment definitions available for a project.
list_environment_definitions_by_catalog	Lists all environment definitions available within a catalog.
list_environment_types	Lists all environment types configured for a project.
list_environments	Lists the environments for a project and user.
list_pools	Lists available pools.
list_projects	Lists all projects.
list_schedules	Lists all schedules within a pool that are configured by your project administrator.
send_request	Runs the network request through the client's chained policies. `>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = client.send_request(request) <HttpResponse: 200 OK>` For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
skip_dev_box_action	Skips an occurrence of an action.

begin_create_dev_box

Creates or replaces a Dev Box.

begin_create_dev_box(project_name: str, user_id: str, dev_box_name: str, body: DevBox | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[DevBox]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute the operation. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str The name of a Dev Box. Required.
body Required	DevBox or <xref:JSON> or IO[bytes] Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator. Is one of the following types: DevBox, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[DevBox]	An instance of LROPoller that returns DevBox. The DevBox is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # JSON input template you can fill out and use as your body input.
   body = {
       "name": "str",  # Display name for the Dev Box. Required.
       "poolName": "str",  # The name of the Dev Box pool this machine belongs to.
         Required.
       "actionState": "str",  # Optional. The current action state of the Dev Box.
         This is state is based on previous action performed by user.
       "createdTime": "2020-02-20 00:00:00",  # Optional. Creation time of this Dev
         Box.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether the owner of the
         Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
       "location": "str",  # Optional. Azure region where this Dev Box is located.
         This will be the same region as the Virtual Network it is attached to.
       "osType": "str",  # Optional. The operating system type of this Dev Box.
         "Windows"
       "powerState": "str",  # Optional. The current power state of the Dev Box.
         Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and
         "Hibernated".
       "projectName": "str",  # Optional. Name of the project this Dev Box belongs
         to.
       "provisioningState": "str",  # Optional. The current provisioning state of
         the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Deleting", "Updating", "Starting", "Stopping", "Provisioning",
         "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       },
       "uniqueId": "str",  # Optional. A unique identifier for the Dev Box. This is
         a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
       "user": "str"  # Optional. The AAD object id of the user this Dev Box is
         assigned to.
   }

   # response body for status code(s): 200, 201
   response == {
       "name": "str",  # Display name for the Dev Box. Required.
       "poolName": "str",  # The name of the Dev Box pool this machine belongs to.
         Required.
       "actionState": "str",  # Optional. The current action state of the Dev Box.
         This is state is based on previous action performed by user.
       "createdTime": "2020-02-20 00:00:00",  # Optional. Creation time of this Dev
         Box.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether the owner of the
         Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
       "location": "str",  # Optional. Azure region where this Dev Box is located.
         This will be the same region as the Virtual Network it is attached to.
       "osType": "str",  # Optional. The operating system type of this Dev Box.
         "Windows"
       "powerState": "str",  # Optional. The current power state of the Dev Box.
         Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and
         "Hibernated".
       "projectName": "str",  # Optional. Name of the project this Dev Box belongs
         to.
       "provisioningState": "str",  # Optional. The current provisioning state of
         the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Deleting", "Updating", "Starting", "Stopping", "Provisioning",
         "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       },
       "uniqueId": "str",  # Optional. A unique identifier for the Dev Box. This is
         a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
       "user": "str"  # Optional. The AAD object id of the user this Dev Box is
         assigned to.
   }

begin_create_or_update_environment

Creates or updates an environment.

begin_create_or_update_environment(project_name: str, user_id: str, environment_name: str, body: Environment | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[Environment]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
environment_name Required	str The name of the environment. Required.
body Required	Environment or <xref:JSON> or IO[bytes] Represents an environment. Is one of the following types: Environment, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[Environment]	An instance of LROPoller that returns Environment. The Environment is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # JSON input template you can fill out and use as your body input.
   body = {
       "catalogName": "str",  # Name of the catalog. Required.
       "environmentDefinitionName": "str",  # Name of the environment definition.
         Required.
       "environmentType": "str",  # Environment type. Required.
       "name": "str",  # Environment name. Required.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "parameters": {
           "str": {}  # Optional. Parameters object for the environment.
       },
       "provisioningState": "str",  # Optional. The provisioning state of the
         environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing",
         "MovingResources", "TransientFailure", and "StorageProvisioningFailed".
       "resourceGroupId": "str",  # Optional. The identifier of the resource group
         containing the environment's resources.
       "user": "str"  # Optional. The AAD object id of the owner of this
         Environment.
   }

   # response body for status code(s): 201
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "environmentDefinitionName": "str",  # Name of the environment definition.
         Required.
       "environmentType": "str",  # Environment type. Required.
       "name": "str",  # Environment name. Required.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "parameters": {
           "str": {}  # Optional. Parameters object for the environment.
       },
       "provisioningState": "str",  # Optional. The provisioning state of the
         environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing",
         "MovingResources", "TransientFailure", and "StorageProvisioningFailed".
       "resourceGroupId": "str",  # Optional. The identifier of the resource group
         containing the environment's resources.
       "user": "str"  # Optional. The AAD object id of the owner of this
         Environment.
   }

begin_delete_dev_box

Deletes a Dev Box.

begin_delete_dev_box(project_name: str, user_id: str, dev_box_name: str, **kwargs: Any) -> LROPoller[OperationDetails]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str The name of a Dev Box. Required.

Returns

Type	Description
LROPoller[OperationDetails]	An instance of LROPoller that returns OperationDetails. The OperationDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 202
   response == {
       "id": "str",  # Fully qualified ID for the operation status. Required.
       "name": "str",  # The operation id name. Required.
       "status": "str",  # Provisioning state of the resource. Required. Known
         values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled".
       "endTime": "2020-02-20 00:00:00",  # Optional. The end time of the operation.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "percentComplete": 0.0,  # Optional. Percent of the operation that is
         complete.
       "properties": {},  # Optional. Custom operation properties, populated only
         for a successful operation.
       "resourceId": "str",  # Optional. The id of the resource.
       "startTime": "2020-02-20 00:00:00"  # Optional. The start time of the
         operation.
   }

begin_delete_environment

Deletes an environment and all its associated resources.

begin_delete_environment(project_name: str, user_id: str, environment_name: str, **kwargs: Any) -> LROPoller[OperationDetails]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
environment_name Required	str The name of the environment. Required.

Returns

Type	Description
LROPoller[OperationDetails]	An instance of LROPoller that returns OperationDetails. The OperationDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 202
   response == {
       "id": "str",  # Fully qualified ID for the operation status. Required.
       "name": "str",  # The operation id name. Required.
       "status": "str",  # Provisioning state of the resource. Required. Known
         values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled".
       "endTime": "2020-02-20 00:00:00",  # Optional. The end time of the operation.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "percentComplete": 0.0,  # Optional. Percent of the operation that is
         complete.
       "properties": {},  # Optional. Custom operation properties, populated only
         for a successful operation.
       "resourceId": "str",  # Optional. The id of the resource.
       "startTime": "2020-02-20 00:00:00"  # Optional. The start time of the
         operation.
   }

begin_restart_dev_box

Restarts a Dev Box.

begin_restart_dev_box(project_name: str, user_id: str, dev_box_name: str, **kwargs: Any) -> LROPoller[OperationDetails]

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.

Returns

Type	Description
LROPoller[OperationDetails]	An instance of LROPoller that returns OperationDetails. The OperationDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 202
   response == {
       "id": "str",  # Fully qualified ID for the operation status. Required.
       "name": "str",  # The operation id name. Required.
       "status": "str",  # Provisioning state of the resource. Required. Known
         values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled".
       "endTime": "2020-02-20 00:00:00",  # Optional. The end time of the operation.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "percentComplete": 0.0,  # Optional. Percent of the operation that is
         complete.
       "properties": {},  # Optional. Custom operation properties, populated only
         for a successful operation.
       "resourceId": "str",  # Optional. The id of the resource.
       "startTime": "2020-02-20 00:00:00"  # Optional. The start time of the
         operation.
   }

begin_start_dev_box

Starts a Dev Box.

begin_start_dev_box(project_name: str, user_id: str, dev_box_name: str, **kwargs: Any) -> LROPoller[OperationDetails]

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.

Returns

Type	Description
LROPoller[OperationDetails]	An instance of LROPoller that returns OperationDetails. The OperationDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 202
   response == {
       "id": "str",  # Fully qualified ID for the operation status. Required.
       "name": "str",  # The operation id name. Required.
       "status": "str",  # Provisioning state of the resource. Required. Known
         values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled".
       "endTime": "2020-02-20 00:00:00",  # Optional. The end time of the operation.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "percentComplete": 0.0,  # Optional. Percent of the operation that is
         complete.
       "properties": {},  # Optional. Custom operation properties, populated only
         for a successful operation.
       "resourceId": "str",  # Optional. The id of the resource.
       "startTime": "2020-02-20 00:00:00"  # Optional. The start time of the
         operation.
   }

begin_stop_dev_box

Stops a Dev Box.

begin_stop_dev_box(project_name: str, user_id: str, dev_box_name: str, *, hibernate: bool | None = None, **kwargs: Any) -> LROPoller[OperationDetails]

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.

Keyword-Only Parameters

Name	Description
hibernate	bool Optional parameter to hibernate the dev box. Default value is None. Default value: None

Returns

Type	Description
LROPoller[OperationDetails]	An instance of LROPoller that returns OperationDetails. The OperationDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 202
   response == {
       "id": "str",  # Fully qualified ID for the operation status. Required.
       "name": "str",  # The operation id name. Required.
       "status": "str",  # Provisioning state of the resource. Required. Known
         values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled".
       "endTime": "2020-02-20 00:00:00",  # Optional. The end time of the operation.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "percentComplete": 0.0,  # Optional. Percent of the operation that is
         complete.
       "properties": {},  # Optional. Custom operation properties, populated only
         for a successful operation.
       "resourceId": "str",  # Optional. The id of the resource.
       "startTime": "2020-02-20 00:00:00"  # Optional. The start time of the
         operation.
   }

close

close() -> None

delay_all_dev_box_actions

Delays all actions.

delay_all_dev_box_actions(project_name: str, user_id: str, dev_box_name: str, *, delay_until: datetime, **kwargs: Any) -> Iterable[DevBoxActionDelayResult]

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.

Keyword-Only Parameters

Name	Description
delay_until	datetime The time to delay the Dev Box action or actions until. Required.

Returns

Type	Description
ItemPaged[DevBoxActionDelayResult]	An iterator like instance of DevBoxActionDelayResult

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # The name of the action. Required.
       "result": "str",  # The result of the delay operation on this action.
         Required. Known values are: "Succeeded" and "Failed".
       "action": {
           "actionType": "str",  # The action that will be taken. Required.
             "Stop"
           "name": "str",  # The name of the action. Required.
           "sourceId": "str",  # The id of the resource which triggered this
             action. Required.
           "next": {
               "scheduledTime": "2020-02-20 00:00:00"  # The time the action
                 will be triggered (UTC). Required.
           },
           "suspendedUntil": "2020-02-20 00:00:00"  # Optional. The earliest
             time that the action could occur (UTC).
       },
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       }
   }

delay_dev_box_action

Delays the occurrence of an action.

delay_dev_box_action(project_name: str, user_id: str, dev_box_name: str, action_name: str, *, delay_until: datetime, **kwargs: Any) -> DevBoxAction

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.
action_name Required	str The name of the action. Required.

Keyword-Only Parameters

Name	Description
delay_until	datetime The time to delay the Dev Box action or actions until. Required.

Returns

Type	Description
DevBoxAction	DevBoxAction. The DevBoxAction is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "actionType": "str",  # The action that will be taken. Required. "Stop"
       "name": "str",  # The name of the action. Required.
       "sourceId": "str",  # The id of the resource which triggered this action.
         Required.
       "next": {
           "scheduledTime": "2020-02-20 00:00:00"  # The time the action will be
             triggered (UTC). Required.
       },
       "suspendedUntil": "2020-02-20 00:00:00"  # Optional. The earliest time that
         the action could occur (UTC).
   }

get_catalog

Gets the specified catalog within the project.

get_catalog(project_name: str, catalog_name: str, **kwargs: Any) -> Catalog

Parameters

Name	Description
project_name Required	str Name of the project. Required.
catalog_name Required	str Name of the catalog. Required.

Returns

Type	Description
Catalog	Catalog. The Catalog is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str"  # Name of the catalog. Required.
   }

get_dev_box

Gets a Dev Box.

get_dev_box(project_name: str, user_id: str, dev_box_name: str, **kwargs: Any) -> DevBox

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.

Returns

Type	Description
DevBox	DevBox. The DevBox is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # Display name for the Dev Box. Required.
       "poolName": "str",  # The name of the Dev Box pool this machine belongs to.
         Required.
       "actionState": "str",  # Optional. The current action state of the Dev Box.
         This is state is based on previous action performed by user.
       "createdTime": "2020-02-20 00:00:00",  # Optional. Creation time of this Dev
         Box.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether the owner of the
         Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
       "location": "str",  # Optional. Azure region where this Dev Box is located.
         This will be the same region as the Virtual Network it is attached to.
       "osType": "str",  # Optional. The operating system type of this Dev Box.
         "Windows"
       "powerState": "str",  # Optional. The current power state of the Dev Box.
         Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and
         "Hibernated".
       "projectName": "str",  # Optional. Name of the project this Dev Box belongs
         to.
       "provisioningState": "str",  # Optional. The current provisioning state of
         the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Deleting", "Updating", "Starting", "Stopping", "Provisioning",
         "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       },
       "uniqueId": "str",  # Optional. A unique identifier for the Dev Box. This is
         a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
       "user": "str"  # Optional. The AAD object id of the user this Dev Box is
         assigned to.
   }

get_dev_box_action

Gets an action.

get_dev_box_action(project_name: str, user_id: str, dev_box_name: str, action_name: str, **kwargs: Any) -> DevBoxAction

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.
action_name Required	str The name of the action. Required.

Returns

Type	Description
DevBoxAction	DevBoxAction. The DevBoxAction is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "actionType": "str",  # The action that will be taken. Required. "Stop"
       "name": "str",  # The name of the action. Required.
       "sourceId": "str",  # The id of the resource which triggered this action.
         Required.
       "next": {
           "scheduledTime": "2020-02-20 00:00:00"  # The time the action will be
             triggered (UTC). Required.
       },
       "suspendedUntil": "2020-02-20 00:00:00"  # Optional. The earliest time that
         the action could occur (UTC).
   }

get_environment

Gets an environment.

get_environment(project_name: str, user_id: str, environment_name: str, **kwargs: Any) -> Environment

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
environment_name Required	str Environment name. Required.

Returns

Type	Description
Environment	Environment. The Environment is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "environmentDefinitionName": "str",  # Name of the environment definition.
         Required.
       "environmentType": "str",  # Environment type. Required.
       "name": "str",  # Environment name. Required.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "parameters": {
           "str": {}  # Optional. Parameters object for the environment.
       },
       "provisioningState": "str",  # Optional. The provisioning state of the
         environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing",
         "MovingResources", "TransientFailure", and "StorageProvisioningFailed".
       "resourceGroupId": "str",  # Optional. The identifier of the resource group
         containing the environment's resources.
       "user": "str"  # Optional. The AAD object id of the owner of this
         Environment.
   }

get_environment_definition

Get an environment definition from a catalog.

get_environment_definition(project_name: str, catalog_name: str, definition_name: str, **kwargs: Any) -> EnvironmentDefinition

Parameters

Name	Description
project_name Required	str Name of the project. Required.
catalog_name Required	str Name of the catalog. Required.
definition_name Required	str Name of the environment definition. Required.

Returns

Type	Description
EnvironmentDefinition	EnvironmentDefinition. The EnvironmentDefinition is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "id": "str",  # The ID of the environment definition. Required.
       "name": "str",  # Name of the environment definition. Required.
       "description": "str",  # Optional. A short description of the environment
         definition.
       "parameters": [
           {
               "id": "str",  # Unique ID of the parameter. Required.
               "required": bool,  # Whether or not this parameter is
                 required. Required.
               "type": "str",  # A string of one of the basic JSON types
                 (number, integer, array, object, boolean, string). Required. Known values
                 are: "array", "boolean", "integer", "number", "object", and "string".
               "allowed": [
                   "str"  # Optional. An array of allowed values.
               ],
               "default": "str",  # Optional. Default value of the
                 parameter.
               "description": "str",  # Optional. Description of the
                 parameter.
               "name": "str",  # Optional. Display name of the parameter.
               "readOnly": bool  # Optional. Whether or not this parameter
                 is read-only.  If true, default should have a value.
           }
       ],
       "parametersSchema": "str",  # Optional. JSON schema defining the parameters
         object passed to an environment.
       "templatePath": "str"  # Optional. Path to the Environment Definition
         entrypoint file.
   }

get_pool

Gets a pool.

get_pool(project_name: str, pool_name: str, **kwargs: Any) -> Pool

Parameters

Name	Description
project_name Required	str Name of the project. Required.
pool_name Required	str Pool name. Required.

Returns

Type	Description
Pool	Pool. The Pool is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "healthStatus": "str",  # Overall health status of the Pool. Indicates
         whether or not the Pool is available to create Dev Boxes. Required. Known values
         are: "Unknown", "Pending", "Healthy", "Warning", and "Unhealthy".
       "location": "str",  # Azure region where Dev Boxes in the pool are located.
         Required.
       "name": "str",  # Pool name. Required.
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether owners of Dev
         Boxes in this pool are local administrators on the Dev Boxes. Known values are:
         "Enabled" and "Disabled".
       "osType": "str",  # Optional. The operating system type of Dev Boxes in this
         pool. "Windows"
       "stopOnDisconnect": {
           "status": "str",  # Indicates whether the feature to stop the devbox
             on disconnect once the grace period has lapsed is enabled. Required. Known
             values are: "Enabled" and "Disabled".
           "gracePeriodMinutes": 0  # Optional. The specified time in minutes to
             wait before stopping a Dev Box once disconnect is detected.
       },
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       }
   }

get_project

Gets a project.

get_project(project_name: str, **kwargs: Any) -> Project

Parameters

Name	Description
project_name Required	str Name of the project. Required.

Returns

Type	Description
Project	Project. The Project is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # Name of the project. Required.
       "description": "str",  # Optional. Description of the project.
       "maxDevBoxesPerUser": 0  # Optional. When specified, indicates the maximum
         number of Dev Boxes a single user can create across all pools in the project.
   }

get_remote_connection

Gets RDP Connection info.

get_remote_connection(project_name: str, user_id: str, dev_box_name: str, **kwargs: Any) -> RemoteConnection

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str The name of a Dev Box. Required.

Returns

Type	Description
RemoteConnection	RemoteConnection. The RemoteConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "rdpConnectionUrl": "str",  # Optional. Link to open a Remote Desktop
         session.
       "webUrl": "str"  # Optional. URL to open a browser based RDP session.
   }

get_schedule

Gets a schedule.

get_schedule(project_name: str, pool_name: str, schedule_name: str, **kwargs: Any) -> Schedule

Parameters

Name	Description
project_name Required	str Name of the project. Required.
pool_name Required	str Pool name. Required.
schedule_name Required	str Display name for the Schedule. Required.

Returns

Type	Description
Schedule	Schedule. The Schedule is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "frequency": "str",  # The frequency of this scheduled task. Required.
         "Daily"
       "name": "str",  # Display name for the Schedule. Required.
       "time": "str",  # The target time to trigger the action. The format is HH:MM.
         Required.
       "timeZone": "str",  # The IANA timezone id at which the schedule should
         execute. Required.
       "type": "str"  # Supported type this scheduled task represents. Required.
         "StopDevBox"
   }

list_all_dev_boxes

Lists Dev Boxes that the caller has access to in the DevCenter.

list_all_dev_boxes(**kwargs: Any) -> Iterable[DevBox]

Returns

Type	Description
ItemPaged[DevBox]	An iterator like instance of DevBox

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # Display name for the Dev Box. Required.
       "poolName": "str",  # The name of the Dev Box pool this machine belongs to.
         Required.
       "actionState": "str",  # Optional. The current action state of the Dev Box.
         This is state is based on previous action performed by user.
       "createdTime": "2020-02-20 00:00:00",  # Optional. Creation time of this Dev
         Box.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether the owner of the
         Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
       "location": "str",  # Optional. Azure region where this Dev Box is located.
         This will be the same region as the Virtual Network it is attached to.
       "osType": "str",  # Optional. The operating system type of this Dev Box.
         "Windows"
       "powerState": "str",  # Optional. The current power state of the Dev Box.
         Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and
         "Hibernated".
       "projectName": "str",  # Optional. Name of the project this Dev Box belongs
         to.
       "provisioningState": "str",  # Optional. The current provisioning state of
         the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Deleting", "Updating", "Starting", "Stopping", "Provisioning",
         "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       },
       "uniqueId": "str",  # Optional. A unique identifier for the Dev Box. This is
         a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
       "user": "str"  # Optional. The AAD object id of the user this Dev Box is
         assigned to.
   }

list_all_dev_boxes_by_user

Lists Dev Boxes in the Dev Center for a particular user.

list_all_dev_boxes_by_user(user_id: str, **kwargs: Any) -> Iterable[DevBox]

Parameters

Name	Description
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.

Returns

Type	Description
ItemPaged[DevBox]	An iterator like instance of DevBox

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # Display name for the Dev Box. Required.
       "poolName": "str",  # The name of the Dev Box pool this machine belongs to.
         Required.
       "actionState": "str",  # Optional. The current action state of the Dev Box.
         This is state is based on previous action performed by user.
       "createdTime": "2020-02-20 00:00:00",  # Optional. Creation time of this Dev
         Box.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether the owner of the
         Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
       "location": "str",  # Optional. Azure region where this Dev Box is located.
         This will be the same region as the Virtual Network it is attached to.
       "osType": "str",  # Optional. The operating system type of this Dev Box.
         "Windows"
       "powerState": "str",  # Optional. The current power state of the Dev Box.
         Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and
         "Hibernated".
       "projectName": "str",  # Optional. Name of the project this Dev Box belongs
         to.
       "provisioningState": "str",  # Optional. The current provisioning state of
         the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Deleting", "Updating", "Starting", "Stopping", "Provisioning",
         "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       },
       "uniqueId": "str",  # Optional. A unique identifier for the Dev Box. This is
         a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
       "user": "str"  # Optional. The AAD object id of the user this Dev Box is
         assigned to.
   }

list_all_environments

Lists the environments for a project.

list_all_environments(project_name: str, **kwargs: Any) -> Iterable[Environment]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.

Returns

Type	Description
ItemPaged[Environment]	An iterator like instance of Environment

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "environmentDefinitionName": "str",  # Name of the environment definition.
         Required.
       "environmentType": "str",  # Environment type. Required.
       "name": "str",  # Environment name. Required.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "parameters": {
           "str": {}  # Optional. Parameters object for the environment.
       },
       "provisioningState": "str",  # Optional. The provisioning state of the
         environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing",
         "MovingResources", "TransientFailure", and "StorageProvisioningFailed".
       "resourceGroupId": "str",  # Optional. The identifier of the resource group
         containing the environment's resources.
       "user": "str"  # Optional. The AAD object id of the owner of this
         Environment.
   }

list_catalogs

Lists all of the catalogs available for a project.

list_catalogs(project_name: str, **kwargs: Any) -> Iterable[Catalog]

Parameters

Name	Description
project_name Required	str Name of the project. Required.

Returns

Type	Description
ItemPaged[Catalog]	An iterator like instance of Catalog

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str"  # Name of the catalog. Required.
   }

list_dev_box_actions

Lists actions on a Dev Box.

list_dev_box_actions(project_name: str, user_id: str, dev_box_name: str, **kwargs: Any) -> Iterable[DevBoxAction]

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.

Returns

Type	Description
ItemPaged[DevBoxAction]	An iterator like instance of DevBoxAction

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "actionType": "str",  # The action that will be taken. Required. "Stop"
       "name": "str",  # The name of the action. Required.
       "sourceId": "str",  # The id of the resource which triggered this action.
         Required.
       "next": {
           "scheduledTime": "2020-02-20 00:00:00"  # The time the action will be
             triggered (UTC). Required.
       },
       "suspendedUntil": "2020-02-20 00:00:00"  # Optional. The earliest time that
         the action could occur (UTC).
   }

list_dev_boxes

Lists Dev Boxes in the project for a particular user.

list_dev_boxes(project_name: str, user_id: str, **kwargs: Any) -> Iterable[DevBox]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.

Returns

Type	Description
ItemPaged[DevBox]	An iterator like instance of DevBox

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # Display name for the Dev Box. Required.
       "poolName": "str",  # The name of the Dev Box pool this machine belongs to.
         Required.
       "actionState": "str",  # Optional. The current action state of the Dev Box.
         This is state is based on previous action performed by user.
       "createdTime": "2020-02-20 00:00:00",  # Optional. Creation time of this Dev
         Box.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether the owner of the
         Dev Box is a local administrator. Known values are: "Enabled" and "Disabled".
       "location": "str",  # Optional. Azure region where this Dev Box is located.
         This will be the same region as the Virtual Network it is attached to.
       "osType": "str",  # Optional. The operating system type of this Dev Box.
         "Windows"
       "powerState": "str",  # Optional. The current power state of the Dev Box.
         Known values are: "Unknown", "Running", "Deallocated", "PoweredOff", and
         "Hibernated".
       "projectName": "str",  # Optional. Name of the project this Dev Box belongs
         to.
       "provisioningState": "str",  # Optional. The current provisioning state of
         the Dev Box. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Deleting", "Updating", "Starting", "Stopping", "Provisioning",
         "ProvisionedWithWarning", "InGracePeriod", and "NotProvisioned".
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       },
       "uniqueId": "str",  # Optional. A unique identifier for the Dev Box. This is
         a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
       "user": "str"  # Optional. The AAD object id of the user this Dev Box is
         assigned to.
   }

list_environment_definitions

Lists all environment definitions available for a project.

list_environment_definitions(project_name: str, **kwargs: Any) -> Iterable[EnvironmentDefinition]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.

Returns

Type	Description
ItemPaged[EnvironmentDefinition]	An iterator like instance of EnvironmentDefinition

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "id": "str",  # The ID of the environment definition. Required.
       "name": "str",  # Name of the environment definition. Required.
       "description": "str",  # Optional. A short description of the environment
         definition.
       "parameters": [
           {
               "id": "str",  # Unique ID of the parameter. Required.
               "required": bool,  # Whether or not this parameter is
                 required. Required.
               "type": "str",  # A string of one of the basic JSON types
                 (number, integer, array, object, boolean, string). Required. Known values
                 are: "array", "boolean", "integer", "number", "object", and "string".
               "allowed": [
                   "str"  # Optional. An array of allowed values.
               ],
               "default": "str",  # Optional. Default value of the
                 parameter.
               "description": "str",  # Optional. Description of the
                 parameter.
               "name": "str",  # Optional. Display name of the parameter.
               "readOnly": bool  # Optional. Whether or not this parameter
                 is read-only.  If true, default should have a value.
           }
       ],
       "parametersSchema": "str",  # Optional. JSON schema defining the parameters
         object passed to an environment.
       "templatePath": "str"  # Optional. Path to the Environment Definition
         entrypoint file.
   }

list_environment_definitions_by_catalog

Lists all environment definitions available within a catalog.

list_environment_definitions_by_catalog(project_name: str, catalog_name: str, **kwargs: Any) -> Iterable[EnvironmentDefinition]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
catalog_name Required	str The name of the catalog. Required.

Returns

Type	Description
ItemPaged[EnvironmentDefinition]	An iterator like instance of EnvironmentDefinition

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "id": "str",  # The ID of the environment definition. Required.
       "name": "str",  # Name of the environment definition. Required.
       "description": "str",  # Optional. A short description of the environment
         definition.
       "parameters": [
           {
               "id": "str",  # Unique ID of the parameter. Required.
               "required": bool,  # Whether or not this parameter is
                 required. Required.
               "type": "str",  # A string of one of the basic JSON types
                 (number, integer, array, object, boolean, string). Required. Known values
                 are: "array", "boolean", "integer", "number", "object", and "string".
               "allowed": [
                   "str"  # Optional. An array of allowed values.
               ],
               "default": "str",  # Optional. Default value of the
                 parameter.
               "description": "str",  # Optional. Description of the
                 parameter.
               "name": "str",  # Optional. Display name of the parameter.
               "readOnly": bool  # Optional. Whether or not this parameter
                 is read-only.  If true, default should have a value.
           }
       ],
       "parametersSchema": "str",  # Optional. JSON schema defining the parameters
         object passed to an environment.
       "templatePath": "str"  # Optional. Path to the Environment Definition
         entrypoint file.
   }

list_environment_types

Lists all environment types configured for a project.

list_environment_types(project_name: str, **kwargs: Any) -> Iterable[EnvironmentType]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.

Returns

Type	Description
ItemPaged[EnvironmentType]	An iterator like instance of EnvironmentType

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "deploymentTargetId": "str",  # Id of a subscription or management group that
         the environment type will be mapped to. The environment's resources will be
         deployed into this subscription or management group. Required.
       "name": "str",  # Name of the environment type. Required.
       "status": "str"  # Indicates whether this environment type is enabled for use
         in this project. Required. Known values are: "Enabled" and "Disabled".
   }

list_environments

Lists the environments for a project and user.

list_environments(project_name: str, user_id: str, **kwargs: Any) -> Iterable[Environment]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.

Returns

Type	Description
ItemPaged[Environment]	An iterator like instance of Environment

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "catalogName": "str",  # Name of the catalog. Required.
       "environmentDefinitionName": "str",  # Name of the environment definition.
         Required.
       "environmentType": "str",  # Environment type. Required.
       "name": "str",  # Environment name. Required.
       "error": {
           "code": "str",  # One of a server-defined set of error codes.
             Required.
           "message": "str",  # A human-readable representation of the error.
             Required.
           "details": [
               ...
           ],
           "innererror": {
               "code": "str",  # Optional. One of a server-defined set of
                 error codes.
               "innererror": ...
           },
           "target": "str"  # Optional. The target of the error.
       },
       "parameters": {
           "str": {}  # Optional. Parameters object for the environment.
       },
       "provisioningState": "str",  # Optional. The provisioning state of the
         environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating",
         "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing",
         "MovingResources", "TransientFailure", and "StorageProvisioningFailed".
       "resourceGroupId": "str",  # Optional. The identifier of the resource group
         containing the environment's resources.
       "user": "str"  # Optional. The AAD object id of the owner of this
         Environment.
   }

list_pools

Lists available pools.

list_pools(project_name: str, **kwargs: Any) -> Iterable[Pool]

Parameters

Name	Description
project_name Required	str Name of the project. Required.

Returns

Type	Description
ItemPaged[Pool]	An iterator like instance of Pool

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "healthStatus": "str",  # Overall health status of the Pool. Indicates
         whether or not the Pool is available to create Dev Boxes. Required. Known values
         are: "Unknown", "Pending", "Healthy", "Warning", and "Unhealthy".
       "location": "str",  # Azure region where Dev Boxes in the pool are located.
         Required.
       "name": "str",  # Pool name. Required.
       "hardwareProfile": {
           "memoryGB": 0,  # Optional. The amount of memory available for the
             Dev Box.
           "skuName": "str",  # Optional. The name of the SKU. Known values are:
             "general_i_8c32gb256ssd_v2", "general_i_8c32gb512ssd_v2",
             "general_i_8c32gb1024ssd_v2", "general_i_8c32gb2048ssd_v2",
             "general_i_16c64gb256ssd_v2", "general_i_16c64gb512ssd_v2",
             "general_i_16c64gb1024ssd_v2", "general_i_16c64gb2048ssd_v2",
             "general_i_32c128gb512ssd_v2", "general_i_32c128gb1024ssd_v2",
             "general_i_32c128gb2048ssd_v2", "general_a_8c32gb256ssd_v2",
             "general_a_8c32gb512ssd_v2", "general_a_8c32gb1024ssd_v2",
             "general_a_8c32gb2048ssd_v2", "general_a_16c64gb256ssd_v2",
             "general_a_16c64gb512ssd_v2", "general_a_16c64gb1024ssd_v2",
             "general_a_16c64gb2048ssd_v2", "general_a_32c128gb512ssd_v2",
             "general_a_32c128gb1024ssd_v2", and "general_a_32c128gb2048ssd_v2".
           "vCPUs": 0  # Optional. The number of vCPUs available for the Dev
             Box.
       },
       "hibernateSupport": "str",  # Optional. Indicates whether hibernate is
         enabled/disabled or unknown. Known values are: "Enabled", "Disabled", and
         "OsUnsupported".
       "imageReference": {
           "name": "str",  # Optional. The name of the image used.
           "operatingSystem": "str",  # Optional. The operating system of the
             image.
           "osBuildNumber": "str",  # Optional. The operating system build
             number of the image.
           "publishedDate": "2020-02-20 00:00:00",  # Optional. The datetime
             that the backing image version was published.
           "version": "str"  # Optional. The version of the image.
       },
       "localAdministrator": "str",  # Optional. Indicates whether owners of Dev
         Boxes in this pool are local administrators on the Dev Boxes. Known values are:
         "Enabled" and "Disabled".
       "osType": "str",  # Optional. The operating system type of Dev Boxes in this
         pool. "Windows"
       "stopOnDisconnect": {
           "status": "str",  # Indicates whether the feature to stop the devbox
             on disconnect once the grace period has lapsed is enabled. Required. Known
             values are: "Enabled" and "Disabled".
           "gracePeriodMinutes": 0  # Optional. The specified time in minutes to
             wait before stopping a Dev Box once disconnect is detected.
       },
       "storageProfile": {
           "osDisk": {
               "diskSizeGB": 0  # Optional. The size of the OS Disk in
                 gigabytes.
           }
       }
   }

list_projects

Lists all projects.

list_projects(**kwargs: Any) -> Iterable[Project]

Returns

Type	Description
ItemPaged[Project]	An iterator like instance of Project

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "name": "str",  # Name of the project. Required.
       "description": "str",  # Optional. Description of the project.
       "maxDevBoxesPerUser": 0  # Optional. When specified, indicates the maximum
         number of Dev Boxes a single user can create across all pools in the project.
   }

list_schedules

Lists all schedules within a pool that are configured by your project administrator.

list_schedules(project_name: str, pool_name: str, **kwargs: Any) -> Iterable[Schedule]

Parameters

Name	Description
project_name Required	str The DevCenter Project upon which to execute operations. Required.
pool_name Required	str The name of a pool of Dev Boxes. Required.

Returns

Type	Description
ItemPaged[Schedule]	An iterator like instance of Schedule

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "frequency": "str",  # The frequency of this scheduled task. Required.
         "Daily"
       "name": "str",  # Display name for the Schedule. Required.
       "time": "str",  # The target time to trigger the action. The format is HH:MM.
         Required.
       "timeZone": "str",  # The IANA timezone id at which the schedule should
         execute. Required.
       "type": "str"  # Supported type this scheduled task represents. Required.
         "StopDevBox"
   }

send_request

Runs the network request through the client's chained policies.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse

Parameters

Name	Description
request Required	HttpRequest The network request you want to make. Required.

Keyword-Only Parameters

Name	Description
stream	bool Whether the response payload will be streamed. Defaults to False. Default value: False

Returns

Type	Description
HttpResponse	The response of your network call. Does not do error handling on your response.

skip_dev_box_action

Skips an occurrence of an action.

skip_dev_box_action(project_name: str, user_id: str, dev_box_name: str, action_name: str, **kwargs: Any) -> None

Parameters

Name	Description
project_name Required	str Name of the project. Required.
user_id Required	str The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.
dev_box_name Required	str Display name for the Dev Box. Required.
action_name Required	str The name of the action. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?

Share via

DevCenterClient Class

Constructor

Parameters

Keyword-Only Parameters

Methods

begin_create_dev_box

Parameters

Returns

Exceptions

Examples

begin_create_or_update_environment

Parameters

Returns

Exceptions

Examples

begin_delete_dev_box

Parameters

Returns

Exceptions

Examples

begin_delete_environment

Parameters

Returns

Exceptions

Examples

begin_restart_dev_box

Parameters

Returns

Exceptions

Examples

begin_start_dev_box

Parameters

Returns

Exceptions

Examples

begin_stop_dev_box

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

close

delay_all_dev_box_actions

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

delay_dev_box_action

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

get_catalog

Parameters

Returns

Exceptions

Examples

get_dev_box

Parameters

Returns

Exceptions

Examples

get_dev_box_action

Parameters

Returns

Exceptions

Examples

get_environment

Parameters

Returns

Exceptions

Examples

get_environment_definition

Parameters

Returns

Exceptions

Examples