azure.developer.devcenter.aio.operations package

class azure.developer.devcenter.aio.operations.DevBoxesOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevCenterClient’s dev_boxes attribute.

async begin_create_dev_box(project_name: str, dev_box_name: str, body: JSON, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[JSON]

async begin_create_dev_box(project_name: str, dev_box_name: str, body: IO, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[JSON]

Creates or updates a Dev Box.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• body (JSON or IO) – Represents a environment. Is either a JSON type or a IO type. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns JSON object

Return type

AsyncLROPoller[JSON]

Raises

HttpResponseError –

Example

# JSON input template you can fill out and use as your body input.
body = {
    "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.
    "errorDetails": {
        "code": "str",  # Optional. The error code.
        "message": "str"  # Optional. The error message.
    },
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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.
    "name": "str",  # Optional. Display name for the Dev Box.
    "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", "Deallocated", "PoweredOff", "Running", 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.
    "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 == {
    "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.
    "errorDetails": {
        "code": "str",  # Optional. The error code.
        "message": "str"  # Optional. The error message.
    },
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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.
    "name": "str",  # Optional. Display name for the Dev Box.
    "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", "Deallocated", "PoweredOff", "Running", 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.
    "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.
}

async begin_delete_dev_box(project_name: str, dev_box_name: str, user_id: str = 'me', **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a Dev Box.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns None

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_start_dev_box(project_name: str, dev_box_name: str, user_id: str = 'me', **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Starts a Dev Box.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns None

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_stop_dev_box(project_name: str, dev_box_name: str, user_id: str = 'me', *, hibernate: Optional[bool] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Stops a Dev Box.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• hibernate (bool) – Optional parameter to hibernate the dev box. Default value is None.

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns None

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async delay_upcoming_action(project_name: str, dev_box_name: str, upcoming_action_id: str, user_id: str = 'me', *, delay_until: datetime.datetime, **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Delays an Upcoming Action.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• upcoming_action_id (str) – The upcoming action id. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

delay_until (datetime) – The delayed action time (UTC). Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "actionType": "str",  # Optional. The action that will be taken. "Stop"
    "id": "str",  # Optional. Uniquely identifies the action.
    "originalScheduledTime": "2020-02-20 00:00:00",  # Optional. The original
      scheduled time for the action (UTC).
    "reason": "str",  # Optional. The reason for this action. "Schedule"
    "scheduledTime": "2020-02-20 00:00:00",  # Optional. The target time the
      action will be triggered (UTC).
    "sourceId": "str"  # Optional. The id of the resource which triggered this
      action.
}

async get_dev_box_by_user(project_name: str, dev_box_name: str, user_id: str = 'me', **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets a Dev Box.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "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.
    "errorDetails": {
        "code": "str",  # Optional. The error code.
        "message": "str"  # Optional. The error message.
    },
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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.
    "name": "str",  # Optional. Display name for the Dev Box.
    "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", "Deallocated", "PoweredOff", "Running", 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.
    "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.
}

async get_pool(pool_name: str, project_name: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets a pool.

Parameters

• pool_name (str) – The name of a pool of Dev Boxes. Required.

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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".
    "location": "str",  # Optional. Azure region where Dev Boxes in the pool are
      located.
    "name": "str",  # Optional. Pool name.
    "osType": "str",  # Optional. The operating system type of Dev Boxes in this
      pool. "Windows"
    "storageProfile": {
        "osDisk": {
            "diskSizeGB": 0  # Optional. The size of the OS Disk in
              gigabytes.
        }
    }
}

async get_remote_connection(project_name: str, dev_box_name: str, user_id: str = 'me', **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets RDP Connection info.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# 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.
}

async get_schedule_by_pool(project_name: str, pool_name: str, schedule_name: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets a schedule.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• pool_name (str) – The name of a pool of Dev Boxes. Required.

• schedule_name (str) – The name of a schedule. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

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

async get_upcoming_action(project_name: str, dev_box_name: str, upcoming_action_id: str, user_id: str = 'me', **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets an Upcoming Action.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• upcoming_action_id (str) – The upcoming action id. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "actionType": "str",  # Optional. The action that will be taken. "Stop"
    "id": "str",  # Optional. Uniquely identifies the action.
    "originalScheduledTime": "2020-02-20 00:00:00",  # Optional. The original
      scheduled time for the action (UTC).
    "reason": "str",  # Optional. The reason for this action. "Schedule"
    "scheduledTime": "2020-02-20 00:00:00",  # Optional. The target time the
      action will be triggered (UTC).
    "sourceId": "str"  # Optional. The id of the resource which triggered this
      action.
}

list_dev_boxes_by_user(project_name: str, user_id: str = 'me', *, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists Dev Boxes in the project for a particular user.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• filter (str) – An OData filter clause to apply to the operation. Default value is None.

• top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "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.
    "errorDetails": {
        "code": "str",  # Optional. The error code.
        "message": "str"  # Optional. The error message.
    },
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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.
    "name": "str",  # Optional. Display name for the Dev Box.
    "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", "Deallocated", "PoweredOff", "Running", 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.
    "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_pools(project_name: str, *, top: Optional[int] = None, filter: Optional[str] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists available pools.

Parameters

project_name (str) – The DevCenter Project upon which to execute operations. Required.

Keyword Arguments

• top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

• filter (str) – An OData filter clause to apply to the operation. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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".
    "location": "str",  # Optional. Azure region where Dev Boxes in the pool are
      located.
    "name": "str",  # Optional. Pool name.
    "osType": "str",  # Optional. The operating system type of Dev Boxes in this
      pool. "Windows"
    "storageProfile": {
        "osDisk": {
            "diskSizeGB": 0  # Optional. The size of the OS Disk in
              gigabytes.
        }
    }
}

list_schedules_by_pool(project_name: str, pool_name: str, *, top: Optional[int] = None, filter: Optional[str] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists available schedules for a pool.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• pool_name (str) – The name of a pool of Dev Boxes. Required.

Keyword Arguments

• top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

• filter (str) – An OData filter clause to apply to the operation. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

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

list_upcoming_actions(project_name: str, dev_box_name: str, user_id: str = 'me', **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists upcoming actions on a Dev Box.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "actionType": "str",  # Optional. The action that will be taken. "Stop"
    "id": "str",  # Optional. Uniquely identifies the action.
    "originalScheduledTime": "2020-02-20 00:00:00",  # Optional. The original
      scheduled time for the action (UTC).
    "reason": "str",  # Optional. The reason for this action. "Schedule"
    "scheduledTime": "2020-02-20 00:00:00",  # Optional. The target time the
      action will be triggered (UTC).
    "sourceId": "str"  # Optional. The id of the resource which triggered this
      action.
}

async skip_upcoming_action(project_name: str, dev_box_name: str, upcoming_action_id: str, user_id: str = 'me', **kwargs: Any) → None

Skips an Upcoming Action.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• dev_box_name (str) – The name of a Dev Box. Required.

• upcoming_action_id (str) – The upcoming action id. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Returns

None

Return type

None

Raises

HttpResponseError –

class azure.developer.devcenter.aio.operations.DevCenterOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevCenterClient’s dev_center attribute.

async get_project(project_name: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets a project.

Parameters

project_name (str) – The DevCenter Project upon which to execute operations. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "description": "str",  # Optional. Description of the project.
    "name": "str"  # Optional. Name of the project.
}

list_all_dev_boxes(*, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

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

Keyword Arguments

• filter (str) – An OData filter clause to apply to the operation. Default value is None.

• top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "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.
    "errorDetails": {
        "code": "str",  # Optional. The error code.
        "message": "str"  # Optional. The error message.
    },
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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.
    "name": "str",  # Optional. Display name for the Dev Box.
    "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", "Deallocated", "PoweredOff", "Running", 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.
    "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(user_id: str = 'me', *, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

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

Parameters

user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• filter (str) – An OData filter clause to apply to the operation. Default value is None.

• top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "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.
    "errorDetails": {
        "code": "str",  # Optional. The error code.
        "message": "str"  # Optional. The error message.
    },
    "hardwareProfile": {
        "memoryGB": 0,  # Optional. The amount of memory available for the
          Dev Box.
        "skuName": "str",  # Optional. The name of the SKU.
        "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: "Disabled" and "Enabled".
    "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.
    "name": "str",  # Optional. Display name for the Dev Box.
    "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", "Deallocated", "PoweredOff", "Running", 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.
    "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_projects(*, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists all projects.

Keyword Arguments

• filter (str) – An OData filter clause to apply to the operation. Default value is None.

• top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "description": "str",  # Optional. Description of the project.
    "name": "str"  # Optional. Name of the project.
}

class azure.developer.devcenter.aio.operations.EnvironmentsOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevCenterClient’s environments attribute.

async begin_create_or_update_environment(project_name: str, environment_name: str, body: JSON, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[JSON]

async begin_create_or_update_environment(project_name: str, environment_name: str, body: IO, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[JSON]

Creates or updates an environment.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• environment_name (str) – The name of the environment. Required.

• body (JSON or IO) – Represents a environment. Is either a JSON type or a IO type. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns JSON object

Return type

AsyncLROPoller[JSON]

Raises

HttpResponseError –

Example

# JSON input template you can fill out and use as your body input.
body = {
    "environmentType": "str",  # Environment type. Required.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "name": "str",  # Optional. Environment name.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "provisioningState": "str",  # Optional. The provisioning state of the
      environment.
    "resourceGroupId": "str",  # Optional. The identifier of the resource group
      containing the environment's resources.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    },
    "user": "str"  # Optional. The AAD object id of the owner of this
      Environment.
}

# response body for status code(s): 200, 201
response == {
    "environmentType": "str",  # Environment type. Required.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "name": "str",  # Optional. Environment name.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "provisioningState": "str",  # Optional. The provisioning state of the
      environment.
    "resourceGroupId": "str",  # Optional. The identifier of the resource group
      containing the environment's resources.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    },
    "user": "str"  # Optional. The AAD object id of the owner of this
      Environment.
}

async begin_custom_environment_action(project_name: str, environment_name: str, body: JSON, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[None]

async begin_custom_environment_action(project_name: str, environment_name: str, body: IO, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[None]

Executes a custom action.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• environment_name (str) – The name of the environment. Required.

• body (JSON or IO) – Action properties overriding the environment’s default values. Is either a JSON type or a IO type. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns None

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

Example

# JSON input template you can fill out and use as your body input.
body = {
    "actionId": "str",  # The Catalog Item action id to execute. Required.
    "parameters": {}  # Optional. Parameters object for the Action.
}

async begin_delete_environment(project_name: str, environment_name: str, user_id: str = 'me', **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes an environment and all its associated resources.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• environment_name (str) – The name of the environment. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns None

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_deploy_environment_action(project_name: str, environment_name: str, body: JSON, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[None]

async begin_deploy_environment_action(project_name: str, environment_name: str, body: IO, user_id: str = 'me', *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[None]

Executes a deploy action.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• environment_name (str) – The name of the environment. Required.

• body (JSON or IO) – Action properties overriding the environment’s default values. Is either a JSON type or a IO type. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns None

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

Example

# JSON input template you can fill out and use as your body input.
body = {
    "actionId": "str",  # The Catalog Item action id to execute. Required.
    "parameters": {}  # Optional. Parameters object for the Action.
}

async get_catalog_item(project_name: str, catalog_item_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Get a catalog item from a project.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• catalog_item_id (str) – The unique id of the catalog item. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "catalogName": "str",  # Optional. Name of the catalog.
    "id": "str",  # Optional. Unique identifier of the catalog item.
    "name": "str"  # Optional. Name of the catalog item.
}

async get_catalog_item_version(project_name: str, catalog_item_id: str, version: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Get a specific catalog item version from a project.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• catalog_item_id (str) – The unique id of the catalog item. Required.

• version (str) – The version of the catalog item. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "actions": [
        {
            "description": "str",  # Optional. Description of the action.
            "id": "str",  # Optional. Unique identifier of the action.
            "name": "str",  # Optional. Display name of the action.
            "parameters": [
                {
                    "allowed": [
                        {}  # Optional. An array of allowed
                          values.
                    ],
                    "default": {},  # Optional. Default value of
                      the parameter.
                    "description": "str",  # Optional.
                      Description of the parameter.
                    "id": "str",  # Optional. Unique ID 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.
                    "required": bool,  # Optional. Whether or not
                      this parameter is required.
                    "type": "str"  # Optional. A string of one of
                      the basic JSON types (number, integer, null, array, object,
                      boolean, string). Known values are: "array", "boolean",
                      "integer", "null", "number", "object", and "string".
                }
            ],
            "parametersSchema": "str",  # Optional. JSON schema defining
              the parameters specific to the custom action.
            "runner": "str",  # Optional. The container image to use to
              execute the action.
            "type": "str",  # Optional. The action type. Known values
              are: "Custom", "Deploy", and "Delete".
            "typeName": "str"  # Optional. Name of the custom action
              type.
        }
    ],
    "catalogItemId": "str",  # Optional. Unique identifier of the catalog item.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. A long description of the catalog item.
    "eligibleForLatestVersion": bool,  # Optional. Whether the version is
      eligible to be the latest version.
    "parameters": [
        {
            "allowed": [
                {}  # Optional. An array of allowed values.
            ],
            "default": {},  # Optional. Default value of the parameter.
            "description": "str",  # Optional. Description of the
              parameter.
            "id": "str",  # Optional. Unique ID 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.
            "required": bool,  # Optional. Whether or not this parameter
              is required.
            "type": "str"  # Optional. A string of one of the basic JSON
              types (number, integer, null, array, object, boolean, string). Known
              values are: "array", "boolean", "integer", "null", "number", "object",
              and "string".
        }
    ],
    "parametersSchema": "str",  # Optional. JSON schema defining the parameters
      object passed to actions.
    "runner": "str",  # Optional. The default container image to use to execute
      actions.
    "status": "str",  # Optional. Defines whether the specific catalog item
      version can be used. Known values are: "Enabled" and "Disabled".
    "summary": "str",  # Optional. A short summary of the catalog item.
    "templatePath": "str",  # Optional. Path to the catalog item entrypoint file.
    "version": "str"  # Optional. The version of the catalog item.
}

async get_environment_by_user(project_name: str, environment_name: str, user_id: str = 'me', **kwargs: Any) → collections.abc.MutableMapping[str, Any]

Gets an environment.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• environment_name (str) – The name of the environment. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "environmentType": "str",  # Environment type. Required.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "name": "str",  # Optional. Environment name.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "provisioningState": "str",  # Optional. The provisioning state of the
      environment.
    "resourceGroupId": "str",  # Optional. The identifier of the resource group
      containing the environment's resources.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    },
    "user": "str"  # Optional. The AAD object id of the owner of this
      Environment.
}

list_catalog_item_versions(project_name: str, catalog_item_id: str, *, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

List all versions of a catalog item from a project.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• catalog_item_id (str) – The unique id of the catalog item. Required.

Keyword Arguments

top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "actions": [
        {
            "description": "str",  # Optional. Description of the action.
            "id": "str",  # Optional. Unique identifier of the action.
            "name": "str",  # Optional. Display name of the action.
            "parameters": [
                {
                    "allowed": [
                        {}  # Optional. An array of allowed
                          values.
                    ],
                    "default": {},  # Optional. Default value of
                      the parameter.
                    "description": "str",  # Optional.
                      Description of the parameter.
                    "id": "str",  # Optional. Unique ID 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.
                    "required": bool,  # Optional. Whether or not
                      this parameter is required.
                    "type": "str"  # Optional. A string of one of
                      the basic JSON types (number, integer, null, array, object,
                      boolean, string). Known values are: "array", "boolean",
                      "integer", "null", "number", "object", and "string".
                }
            ],
            "parametersSchema": "str",  # Optional. JSON schema defining
              the parameters specific to the custom action.
            "runner": "str",  # Optional. The container image to use to
              execute the action.
            "type": "str",  # Optional. The action type. Known values
              are: "Custom", "Deploy", and "Delete".
            "typeName": "str"  # Optional. Name of the custom action
              type.
        }
    ],
    "catalogItemId": "str",  # Optional. Unique identifier of the catalog item.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. A long description of the catalog item.
    "eligibleForLatestVersion": bool,  # Optional. Whether the version is
      eligible to be the latest version.
    "parameters": [
        {
            "allowed": [
                {}  # Optional. An array of allowed values.
            ],
            "default": {},  # Optional. Default value of the parameter.
            "description": "str",  # Optional. Description of the
              parameter.
            "id": "str",  # Optional. Unique ID 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.
            "required": bool,  # Optional. Whether or not this parameter
              is required.
            "type": "str"  # Optional. A string of one of the basic JSON
              types (number, integer, null, array, object, boolean, string). Known
              values are: "array", "boolean", "integer", "null", "number", "object",
              and "string".
        }
    ],
    "parametersSchema": "str",  # Optional. JSON schema defining the parameters
      object passed to actions.
    "runner": "str",  # Optional. The default container image to use to execute
      actions.
    "status": "str",  # Optional. Defines whether the specific catalog item
      version can be used. Known values are: "Enabled" and "Disabled".
    "summary": "str",  # Optional. A short summary of the catalog item.
    "templatePath": "str",  # Optional. Path to the catalog item entrypoint file.
    "version": "str"  # Optional. The version of the catalog item.
}

list_catalog_items(project_name: str, *, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists latest version of all catalog items available for a project.

Parameters

project_name (str) – The DevCenter Project upon which to execute operations. Required.

Keyword Arguments

top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "catalogName": "str",  # Optional. Name of the catalog.
    "id": "str",  # Optional. Unique identifier of the catalog item.
    "name": "str"  # Optional. Name of the catalog item.
}

list_environment_types(project_name: str, *, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists all environment types configured for a project.

Parameters

project_name (str) – The DevCenter Project upon which to execute operations. Required.

Keyword Arguments

top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "deploymentTargetId": "str",  # Optional. 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.
    "name": "str",  # Optional. Name of the environment type.
    "status": "str"  # Optional. Defines whether this Environment Type can be
      used in this Project. Known values are: "Enabled" and "Disabled".
}

list_environments(project_name: str, *, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists the environments for a project.

Parameters

project_name (str) – The DevCenter Project upon which to execute operations. Required.

Keyword Arguments

top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "environmentType": "str",  # Environment type. Required.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "name": "str",  # Optional. Environment name.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "provisioningState": "str",  # Optional. The provisioning state of the
      environment.
    "resourceGroupId": "str",  # Optional. The identifier of the resource group
      containing the environment's resources.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    },
    "user": "str"  # Optional. The AAD object id of the owner of this
      Environment.
}

list_environments_by_user(project_name: str, user_id: str = 'me', *, top: Optional[int] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]]

Lists the environments for a project and user.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

top (int) – The maximum number of resources to return from the operation. Example: ‘top=10’. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "environmentType": "str",  # Environment type. Required.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "name": "str",  # Optional. Environment name.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "provisioningState": "str",  # Optional. The provisioning state of the
      environment.
    "resourceGroupId": "str",  # Optional. The identifier of the resource group
      containing the environment's resources.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    },
    "user": "str"  # Optional. The AAD object id of the owner of this
      Environment.
}

async update_environment(project_name: str, environment_name: str, body: JSON, user_id: str = 'me', *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON

async update_environment(project_name: str, environment_name: str, body: IO, user_id: str = 'me', *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON

Partially updates an environment.

Parameters

• project_name (str) – The DevCenter Project upon which to execute operations. Required.

• environment_name (str) – The name of the environment. Required.

• body (JSON or IO) – Updatable environment properties. Is either a JSON type or a IO type. Required.

• user_id (str) – The AAD object id of the user. If value is ‘me’, the identity is taken from the authentication context. Default value is “me”.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# JSON input template you can fill out and use as your body input.
body = {
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    }
}

# response body for status code(s): 200
response == {
    "environmentType": "str",  # Environment type. Required.
    "catalogItemName": "str",  # Optional. Name of the catalog item.
    "catalogName": "str",  # Optional. Name of the catalog.
    "description": "str",  # Optional. Description of the Environment.
    "name": "str",  # Optional. Environment name.
    "parameters": {},  # Optional. Parameters object for the deploy action.
    "provisioningState": "str",  # Optional. The provisioning state of the
      environment.
    "resourceGroupId": "str",  # Optional. The identifier of the resource group
      containing the environment's resources.
    "scheduledTasks": {
        "str": {
            "startTime": "2020-02-20 00:00:00",  # Date/time by which the
              environment should expire. Required.
            "type": "str",  # Supported type this scheduled task
              represents. Required. "AutoExpire"
            "enabled": "str"  # Optional. Indicates whether or not this
              scheduled task is enabled. Known values are: "Enabled" and "Disabled".
        }
    },
    "tags": {
        "str": "str"  # Optional. Key value pairs that will be applied to
          resources deployed in this environment as tags.
    },
    "user": "str"  # Optional. The AAD object id of the owner of this
      Environment.
}