azure.mgmt.desktopvirtualization.operations module¶

class azure.mgmt.desktopvirtualization.operations.AppAttachPackageInfoOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s app_attach_package_info attribute.

import_method(resource_group_name: str, host_pool_name: str, import_package_info_request: _models.ImportPackageInfoRequest, *, content_type: str = 'application/json', **kwargs: Any) → Iterable['_models.AppAttachPackage'][source]¶

import_method(resource_group_name: str, host_pool_name: str, import_package_info_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → Iterable['_models.AppAttachPackage']

Gets information from a package given the path to the package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
import_package_info_request (ImportPackageInfoRequest or IO[bytes]) – Object containing URI to package image and other optional properties. Is either a ImportPackageInfoRequest type or a IO[bytes] type. Required.

Returns:

An iterator like instance of either AppAttachPackage or the result of cls(response)

Return type:

ItemPaged[AppAttachPackage]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.AppAttachPackageOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s app_attach_package attribute.

create_or_update(resource_group_name: str, app_attach_package_name: str, app_attach_package: _models.AppAttachPackage, *, content_type: str = 'application/json', **kwargs: Any) → _models.AppAttachPackage[source]¶

create_or_update(resource_group_name: str, app_attach_package_name: str, app_attach_package: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AppAttachPackage

Create or update an App Attach package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
app_attach_package_name (str) – The name of the App Attach package. Required.
app_attach_package (AppAttachPackage or IO[bytes]) – Object containing App Attach Package definitions. Is either a AppAttachPackage type or a IO[bytes] type. Required.

Returns:

AppAttachPackage or the result of cls(response)

Return type:

AppAttachPackage

Raises:

HttpResponseError –

delete(resource_group_name: str, app_attach_package_name: str, **kwargs: Any) → None[source]¶

Remove an App Attach Package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
app_attach_package_name (str) – The name of the App Attach package. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, app_attach_package_name: str, **kwargs: Any) → AppAttachPackage[source]¶

Get an app attach package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
app_attach_package_name (str) – The name of the App Attach package. Required.

Returns:

AppAttachPackage or the result of cls(response)

Return type:

AppAttachPackage

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, filter: str | None = None, **kwargs: Any) → Iterable[AppAttachPackage][source]¶

List App Attach packages in resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
filter (str) – OData filter expression. Valid properties for filtering are package name and host pool. Default value is None.

Returns:

An iterator like instance of either AppAttachPackage or the result of cls(response)

Return type:

ItemPaged[AppAttachPackage]

Raises:

HttpResponseError –

list_by_subscription(filter: str | None = None, **kwargs: Any) → Iterable[AppAttachPackage][source]¶

List App Attach packages in subscription.

Parameters:: filter (str) – OData filter expression. Valid properties for filtering are package name, host pool, and resource group. Default value is None.
Returns:: An iterator like instance of either AppAttachPackage or the result of cls(response)
Return type:: ItemPaged[AppAttachPackage]
Raises:: HttpResponseError –

update(resource_group_name: str, app_attach_package_name: str, app_attach_package_patch: _models.AppAttachPackagePatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.AppAttachPackage[source]¶

update(resource_group_name: str, app_attach_package_name: str, app_attach_package_patch: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.AppAttachPackage

Update an App Attach Package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
app_attach_package_name (str) – The name of the App Attach package. Required.
app_attach_package_patch (AppAttachPackagePatch or IO[bytes]) – Object containing App Attach Package definition. Is either a AppAttachPackagePatch type or a IO[bytes] type. Default value is None.

Returns:

AppAttachPackage or the result of cls(response)

Return type:

AppAttachPackage

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.ApplicationGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s application_groups attribute.

create_or_update(resource_group_name: str, application_group_name: str, application_group: _models.ApplicationGroup, *, content_type: str = 'application/json', **kwargs: Any) → _models.ApplicationGroup[source]¶

create_or_update(resource_group_name: str, application_group_name: str, application_group: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ApplicationGroup

Create or update an applicationGroup.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
application_group (ApplicationGroup or IO[bytes]) – Object containing ApplicationGroup definitions. Is either a ApplicationGroup type or a IO[bytes] type. Required.

Returns:

ApplicationGroup or the result of cls(response)

Return type:

ApplicationGroup

Raises:

HttpResponseError –

delete(resource_group_name: str, application_group_name: str, **kwargs: Any) → None[source]¶

Remove an applicationGroup.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, application_group_name: str, **kwargs: Any) → ApplicationGroup[source]¶

Get an application group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.

Returns:

ApplicationGroup or the result of cls(response)

Return type:

ApplicationGroup

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, filter: str | None = None, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[ApplicationGroup][source]¶

List applicationGroups.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
filter (str) – OData filter expression. Valid properties for filtering are applicationGroupType. Default value is None.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either ApplicationGroup or the result of cls(response)

Return type:

ItemPaged[ApplicationGroup]

Raises:

HttpResponseError –

list_by_subscription(filter: str | None = None, **kwargs: Any) → Iterable[ApplicationGroup][source]¶

List applicationGroups in subscription.

Parameters:: filter (str) – OData filter expression. Valid properties for filtering are applicationGroupType. Default value is None.
Returns:: An iterator like instance of either ApplicationGroup or the result of cls(response)
Return type:: ItemPaged[ApplicationGroup]
Raises:: HttpResponseError –

update(resource_group_name: str, application_group_name: str, application_group: _models.ApplicationGroupPatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ApplicationGroup[source]¶

update(resource_group_name: str, application_group_name: str, application_group: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ApplicationGroup

Update an applicationGroup.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
application_group (ApplicationGroupPatch or IO[bytes]) – Object containing ApplicationGroup definitions. Is either a ApplicationGroupPatch type or a IO[bytes] type. Default value is None.

Returns:

ApplicationGroup or the result of cls(response)

Return type:

ApplicationGroup

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.ApplicationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s applications attribute.

create_or_update(resource_group_name: str, application_group_name: str, application_name: str, application: _models.Application, *, content_type: str = 'application/json', **kwargs: Any) → _models.Application[source]¶

create_or_update(resource_group_name: str, application_group_name: str, application_name: str, application: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Application

Create or update an application.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
application_name (str) – The name of the application within the specified application group. Required.
application (Application or IO[bytes]) – Object containing Application definitions. Is either a Application type or a IO[bytes] type. Required.

Returns:

Application or the result of cls(response)

Return type:

Raises:

HttpResponseError –

delete(resource_group_name: str, application_group_name: str, application_name: str, **kwargs: Any) → None[source]¶

Remove an application.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
application_name (str) – The name of the application within the specified application group. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, application_group_name: str, application_name: str, **kwargs: Any) → Application[source]¶

Get an application.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
application_name (str) – The name of the application within the specified application group. Required.

Returns:

Application or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(resource_group_name: str, application_group_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[Application][source]¶

List applications.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either Application or the result of cls(response)

Return type:

ItemPaged[Application]

Raises:

HttpResponseError –

update(resource_group_name: str, application_group_name: str, application_name: str, application: _models.ApplicationPatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Application[source]¶

update(resource_group_name: str, application_group_name: str, application_name: str, application: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Application

Update an application.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
application_name (str) – The name of the application within the specified application group. Required.
application (ApplicationPatch or IO[bytes]) – Object containing Application definitions. Is either a ApplicationPatch type or a IO[bytes] type. Default value is None.

Returns:

Application or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.DesktopsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s desktops attribute.

get(resource_group_name: str, application_group_name: str, desktop_name: str, **kwargs: Any) → Desktop[source]¶

Get a desktop.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
desktop_name (str) – The name of the desktop within the specified desktop group. Required.

Returns:

Desktop or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(resource_group_name: str, application_group_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[Desktop][source]¶

List desktops.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either Desktop or the result of cls(response)

Return type:

ItemPaged[Desktop]

Raises:

HttpResponseError –

update(resource_group_name: str, application_group_name: str, desktop_name: str, desktop: _models.DesktopPatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Desktop[source]¶

update(resource_group_name: str, application_group_name: str, desktop_name: str, desktop: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Desktop

Update a desktop.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
desktop_name (str) – The name of the desktop within the specified desktop group. Required.
desktop (DesktopPatch or IO[bytes]) – Object containing Desktop definitions. Is either a DesktopPatch type or a IO[bytes] type. Default value is None.

Returns:

Desktop or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.HostPoolsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s host_pools attribute.

create_or_update(resource_group_name: str, host_pool_name: str, host_pool: _models.HostPool, *, content_type: str = 'application/json', **kwargs: Any) → _models.HostPool[source]¶

create_or_update(resource_group_name: str, host_pool_name: str, host_pool: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.HostPool

Create or update a host pool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
host_pool (HostPool or IO[bytes]) – Object containing HostPool definitions. Is either a HostPool type or a IO[bytes] type. Required.

Returns:

HostPool or the result of cls(response)

Return type:

Raises:

HttpResponseError –

delete(resource_group_name: str, host_pool_name: str, force: bool | None = None, **kwargs: Any) → None[source]¶

Remove a host pool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
force (bool) – Force flag to delete sessionHost. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, host_pool_name: str, **kwargs: Any) → HostPool[source]¶

Get a host pool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.

Returns:

HostPool or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[HostPool][source]¶

List hostPools in subscription.

Parameters:

page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either HostPool or the result of cls(response)

Return type:

ItemPaged[HostPool]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[HostPool][source]¶

List hostPools.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either HostPool or the result of cls(response)

Return type:

ItemPaged[HostPool]

Raises:

HttpResponseError –

list_registration_tokens(resource_group_name: str, host_pool_name: str, **kwargs: Any) → RegistrationTokenList[source]¶

Operation to list the RegistrationTokens associated with the HostPool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.

Returns:

RegistrationTokenList or the result of cls(response)

Return type:

RegistrationTokenList

Raises:

HttpResponseError –

retrieve_registration_token(resource_group_name: str, host_pool_name: str, **kwargs: Any) → RegistrationInfo[source]¶

Registration token of the host pool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.

Returns:

RegistrationInfo or the result of cls(response)

Return type:

RegistrationInfo

Raises:

HttpResponseError –

update(resource_group_name: str, host_pool_name: str, host_pool: _models.HostPoolPatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.HostPool[source]¶

update(resource_group_name: str, host_pool_name: str, host_pool: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.HostPool

Update a host pool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
host_pool (HostPoolPatch or IO[bytes]) – Object containing HostPool definitions. Is either a HostPoolPatch type or a IO[bytes] type. Default value is None.

Returns:

HostPool or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.MSIXPackagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s msix_packages attribute.

create_or_update(resource_group_name: str, host_pool_name: str, msix_package_full_name: str, msix_package: _models.MSIXPackage, *, content_type: str = 'application/json', **kwargs: Any) → _models.MSIXPackage[source]¶

create_or_update(resource_group_name: str, host_pool_name: str, msix_package_full_name: str, msix_package: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.MSIXPackage

Create or update a MSIX package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
msix_package_full_name (str) – The version specific package full name of the MSIX package within specified hostpool. Required.
msix_package (MSIXPackage or IO[bytes]) – Object containing MSIX Package definitions. Is either a MSIXPackage type or a IO[bytes] type. Required.

Returns:

MSIXPackage or the result of cls(response)

Return type:

Raises:

HttpResponseError –

delete(resource_group_name: str, host_pool_name: str, msix_package_full_name: str, **kwargs: Any) → None[source]¶

Remove an MSIX Package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
msix_package_full_name (str) – The version specific package full name of the MSIX package within specified hostpool. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, host_pool_name: str, msix_package_full_name: str, **kwargs: Any) → MSIXPackage[source]¶

Get a msixpackage.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
msix_package_full_name (str) – The version specific package full name of the MSIX package within specified hostpool. Required.

Returns:

MSIXPackage or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(resource_group_name: str, host_pool_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[MSIXPackage][source]¶

List MSIX packages in hostpool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either MSIXPackage or the result of cls(response)

Return type:

ItemPaged[MSIXPackage]

Raises:

HttpResponseError –

update(resource_group_name: str, host_pool_name: str, msix_package_full_name: str, msix_package: _models.MSIXPackagePatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.MSIXPackage[source]¶

update(resource_group_name: str, host_pool_name: str, msix_package_full_name: str, msix_package: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.MSIXPackage

Update an MSIX Package.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
msix_package_full_name (str) – The version specific package full name of the MSIX package within specified hostpool. Required.
msix_package (MSIXPackagePatch or IO[bytes]) – Object containing MSIX Package definitions. Is either a MSIXPackagePatch type or a IO[bytes] type. Default value is None.

Returns:

MSIXPackage or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.MsixImagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s msix_images attribute.

expand(resource_group_name: str, host_pool_name: str, msix_image_uri: _models.MSIXImageURI, *, content_type: str = 'application/json', **kwargs: Any) → Iterable['_models.ExpandMsixImage'][source]¶

expand(resource_group_name: str, host_pool_name: str, msix_image_uri: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → Iterable['_models.ExpandMsixImage']

Expands and Lists MSIX packages in an Image, given the Image Path.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
msix_image_uri (MSIXImageURI or IO[bytes]) – Object containing URI to MSIX Image. Is either a MSIXImageURI type or a IO[bytes] type. Required.

Returns:

An iterator like instance of either ExpandMsixImage or the result of cls(response)

Return type:

ItemPaged[ExpandMsixImage]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(**kwargs: Any) → Iterable[ResourceProviderOperation][source]¶

List all of the available operations the Desktop Virtualization resource provider supports.

Returns:: An iterator like instance of either ResourceProviderOperation or the result of cls(response)
Return type:: ItemPaged[ResourceProviderOperation]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s private_endpoint_connections attribute.

delete_by_host_pool(resource_group_name: str, host_pool_name: str, private_endpoint_connection_name: str, **kwargs: Any) → None[source]¶

Remove a connection.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

delete_by_workspace(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → None[source]¶

Remove a connection.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get_by_host_pool(resource_group_name: str, host_pool_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnectionWithSystemData[source]¶

Get a private endpoint connection.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

PrivateEndpointConnectionWithSystemData or the result of cls(response)

Return type:

PrivateEndpointConnectionWithSystemData

Raises:

HttpResponseError –

get_by_workspace(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnectionWithSystemData[source]¶

Get a private endpoint connection.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

PrivateEndpointConnectionWithSystemData or the result of cls(response)

Return type:

PrivateEndpointConnectionWithSystemData

Raises:

HttpResponseError –

list_by_host_pool(resource_group_name: str, host_pool_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[PrivateEndpointConnectionWithSystemData][source]¶

List private endpoint connections associated with hostpool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either PrivateEndpointConnectionWithSystemData or the result of cls(response)

Return type:

ItemPaged[PrivateEndpointConnectionWithSystemData]

Raises:

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnectionWithSystemData][source]¶

List private endpoint connections.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Returns:

An iterator like instance of either PrivateEndpointConnectionWithSystemData or the result of cls(response)

Return type:

ItemPaged[PrivateEndpointConnectionWithSystemData]

Raises:

HttpResponseError –

update_by_host_pool(resource_group_name: str, host_pool_name: str, private_endpoint_connection_name: str, connection: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → _models.PrivateEndpointConnectionWithSystemData[source]¶

update_by_host_pool(resource_group_name: str, host_pool_name: str, private_endpoint_connection_name: str, connection: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.PrivateEndpointConnectionWithSystemData

Approve or reject a private endpoint connection.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.
connection (PrivateEndpointConnection or IO[bytes]) – Object containing the updated connection. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

PrivateEndpointConnectionWithSystemData or the result of cls(response)

Return type:

PrivateEndpointConnectionWithSystemData

Raises:

HttpResponseError –

update_by_workspace(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, connection: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → _models.PrivateEndpointConnectionWithSystemData[source]¶

update_by_workspace(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, connection: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.PrivateEndpointConnectionWithSystemData

Approve or reject a private endpoint connection.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.
connection (PrivateEndpointConnection or IO[bytes]) – Object containing the updated connection. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

PrivateEndpointConnectionWithSystemData or the result of cls(response)

Return type:

PrivateEndpointConnectionWithSystemData

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s private_link_resources attribute.

list_by_host_pool(resource_group_name: str, host_pool_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[PrivateLinkResource][source]¶

List the private link resources available for this hostpool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either PrivateLinkResource or the result of cls(response)

Return type:

ItemPaged[PrivateLinkResource]

Raises:

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[PrivateLinkResource][source]¶

List the private link resources available for this workspace.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either PrivateLinkResource or the result of cls(response)

Return type:

ItemPaged[PrivateLinkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.ScalingPlanPersonalSchedulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s scaling_plan_personal_schedules attribute.

create(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: _models.ScalingPlanPersonalSchedule, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPersonalSchedule[source]¶

create(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPersonalSchedule

Create or update a ScalingPlanPersonalSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.
scaling_plan_schedule (ScalingPlanPersonalSchedule or IO[bytes]) – Object containing ScalingPlanPersonalSchedule definitions. Is either a ScalingPlanPersonalSchedule type or a IO[bytes] type. Required.

Returns:

ScalingPlanPersonalSchedule or the result of cls(response)

Return type:

ScalingPlanPersonalSchedule

Raises:

HttpResponseError –

delete(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, **kwargs: Any) → None[source]¶

Remove a ScalingPlanPersonalSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, **kwargs: Any) → ScalingPlanPersonalSchedule[source]¶

Get a ScalingPlanPersonalSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.

Returns:

ScalingPlanPersonalSchedule or the result of cls(response)

Return type:

ScalingPlanPersonalSchedule

Raises:

HttpResponseError –

list(resource_group_name: str, scaling_plan_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[ScalingPlanPersonalSchedule][source]¶

List ScalingPlanPersonalSchedules.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either ScalingPlanPersonalSchedule or the result of cls(response)

Return type:

ItemPaged[ScalingPlanPersonalSchedule]

Raises:

HttpResponseError –

update(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: _models.ScalingPlanPersonalSchedulePatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPersonalSchedule[source]¶

update(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPersonalSchedule

Update a ScalingPlanPersonalSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.
scaling_plan_schedule (ScalingPlanPersonalSchedulePatch or IO[bytes]) – Object containing ScalingPlanPersonalSchedule definitions. Is either a ScalingPlanPersonalSchedulePatch type or a IO[bytes] type. Default value is None.

Returns:

ScalingPlanPersonalSchedule or the result of cls(response)

Return type:

ScalingPlanPersonalSchedule

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.ScalingPlanPooledSchedulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s scaling_plan_pooled_schedules attribute.

create(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: _models.ScalingPlanPooledSchedule, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPooledSchedule[source]¶

create(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPooledSchedule

Create or update a ScalingPlanPooledSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.
scaling_plan_schedule (ScalingPlanPooledSchedule or IO[bytes]) – Object containing ScalingPlanPooledSchedule definitions. Is either a ScalingPlanPooledSchedule type or a IO[bytes] type. Required.

Returns:

ScalingPlanPooledSchedule or the result of cls(response)

Return type:

ScalingPlanPooledSchedule

Raises:

HttpResponseError –

delete(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, **kwargs: Any) → None[source]¶

Remove a ScalingPlanPooledSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, **kwargs: Any) → ScalingPlanPooledSchedule[source]¶

Get a ScalingPlanPooledSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.

Returns:

ScalingPlanPooledSchedule or the result of cls(response)

Return type:

ScalingPlanPooledSchedule

Raises:

HttpResponseError –

list(resource_group_name: str, scaling_plan_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[ScalingPlanPooledSchedule][source]¶

List ScalingPlanPooledSchedules.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either ScalingPlanPooledSchedule or the result of cls(response)

Return type:

ItemPaged[ScalingPlanPooledSchedule]

Raises:

HttpResponseError –

update(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: _models.ScalingPlanPooledSchedulePatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPooledSchedule[source]¶

update(resource_group_name: str, scaling_plan_name: str, scaling_plan_schedule_name: str, scaling_plan_schedule: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlanPooledSchedule

Update a ScalingPlanPooledSchedule.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan_schedule_name (str) – The name of the ScalingPlanSchedule. Required.
scaling_plan_schedule (ScalingPlanPooledSchedulePatch or IO[bytes]) – Object containing ScalingPlanPooledSchedule definitions. Is either a ScalingPlanPooledSchedulePatch type or a IO[bytes] type. Default value is None.

Returns:

ScalingPlanPooledSchedule or the result of cls(response)

Return type:

ScalingPlanPooledSchedule

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.ScalingPlansOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s scaling_plans attribute.

create(resource_group_name: str, scaling_plan_name: str, scaling_plan: _models.ScalingPlan, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlan[source]¶

create(resource_group_name: str, scaling_plan_name: str, scaling_plan: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlan

Create or update a scaling plan.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan (ScalingPlan or IO[bytes]) – Object containing scaling plan definitions. Is either a ScalingPlan type or a IO[bytes] type. Required.

Returns:

ScalingPlan or the result of cls(response)

Return type:

Raises:

HttpResponseError –

delete(resource_group_name: str, scaling_plan_name: str, **kwargs: Any) → None[source]¶

Remove a scaling plan.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, scaling_plan_name: str, **kwargs: Any) → ScalingPlan[source]¶

Get a scaling plan.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.

Returns:

ScalingPlan or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list_by_host_pool(resource_group_name: str, host_pool_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[ScalingPlan][source]¶

List scaling plan associated with hostpool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either ScalingPlan or the result of cls(response)

Return type:

ItemPaged[ScalingPlan]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[ScalingPlan][source]¶

List scaling plans.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either ScalingPlan or the result of cls(response)

Return type:

ItemPaged[ScalingPlan]

Raises:

HttpResponseError –

list_by_subscription(page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[ScalingPlan][source]¶

List scaling plans in subscription.

Parameters:

page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either ScalingPlan or the result of cls(response)

Return type:

ItemPaged[ScalingPlan]

Raises:

HttpResponseError –

update(resource_group_name: str, scaling_plan_name: str, scaling_plan: _models.ScalingPlanPatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlan[source]¶

update(resource_group_name: str, scaling_plan_name: str, scaling_plan: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.ScalingPlan

Update a scaling plan.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
scaling_plan_name (str) – The name of the scaling plan. Required.
scaling_plan (ScalingPlanPatch or IO[bytes]) – Object containing scaling plan definitions. Is either a ScalingPlanPatch type or a IO[bytes] type. Default value is None.

Returns:

ScalingPlan or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.SessionHostsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s session_hosts attribute.

delete(resource_group_name: str, host_pool_name: str, session_host_name: str, force: bool | None = None, **kwargs: Any) → None[source]¶

Remove a SessionHost.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
force (bool) – Force flag to force sessionHost deletion even when userSession exists. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, host_pool_name: str, session_host_name: str, **kwargs: Any) → SessionHost[source]¶

Get a session host.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.

Returns:

SessionHost or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(resource_group_name: str, host_pool_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[SessionHost][source]¶

List sessionHosts.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either SessionHost or the result of cls(response)

Return type:

ItemPaged[SessionHost]

Raises:

HttpResponseError –

update(resource_group_name: str, host_pool_name: str, session_host_name: str, force: bool | None = None, session_host: _models.SessionHostPatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.SessionHost[source]¶

update(resource_group_name: str, host_pool_name: str, session_host_name: str, force: bool | None = None, session_host: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.SessionHost

Update a session host.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
force (bool) – Force flag to update assign, unassign or reassign personal desktop. Default value is None.
session_host (SessionHostPatch or IO[bytes]) – Object containing SessionHost definitions. Is either a SessionHostPatch type or a IO[bytes] type. Default value is None.

Returns:

SessionHost or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.StartMenuItemsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s start_menu_items attribute.

list(resource_group_name: str, application_group_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[StartMenuItem][source]¶

List start menu items in the given application group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
application_group_name (str) – The name of the application group. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either StartMenuItem or the result of cls(response)

Return type:

ItemPaged[StartMenuItem]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.UserSessionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s user_sessions attribute.

delete(resource_group_name: str, host_pool_name: str, session_host_name: str, user_session_id: str, force: bool | None = None, **kwargs: Any) → None[source]¶

Remove a userSession.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
user_session_id (str) – The name of the user session within the specified session host. Required.
force (bool) – Force flag to login off userSession. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

disconnect(resource_group_name: str, host_pool_name: str, session_host_name: str, user_session_id: str, **kwargs: Any) → None[source]¶

Disconnect a userSession.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
user_session_id (str) – The name of the user session within the specified session host. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, host_pool_name: str, session_host_name: str, user_session_id: str, **kwargs: Any) → UserSession[source]¶

Get a userSession.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
user_session_id (str) – The name of the user session within the specified session host. Required.

Returns:

UserSession or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(resource_group_name: str, host_pool_name: str, session_host_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[UserSession][source]¶

List userSessions.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either UserSession or the result of cls(response)

Return type:

ItemPaged[UserSession]

Raises:

HttpResponseError –

list_by_host_pool(resource_group_name: str, host_pool_name: str, filter: str | None = None, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[UserSession][source]¶

List userSessions.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
filter (str) – OData filter expression. Valid properties for filtering are userprincipalname and sessionstate. Default value is None.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either UserSession or the result of cls(response)

Return type:

ItemPaged[UserSession]

Raises:

HttpResponseError –

send_message(resource_group_name: str, host_pool_name: str, session_host_name: str, user_session_id: str, send_message: _models.SendMessage | None = None, *, content_type: str = 'application/json', **kwargs: Any) → None[source]¶

send_message(resource_group_name: str, host_pool_name: str, session_host_name: str, user_session_id: str, send_message: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → None

Send a message to a user.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
host_pool_name (str) – The name of the host pool within the specified resource group. Required.
session_host_name (str) – The name of the session host within the specified host pool. Required.
user_session_id (str) – The name of the user session within the specified session host. Required.
send_message (SendMessage or IO[bytes]) – Object containing message includes title and message body. Is either a SendMessage type or a IO[bytes] type. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶

class azure.mgmt.desktopvirtualization.operations.WorkspacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DesktopVirtualizationMgmtClient’s workspaces attribute.

create_or_update(resource_group_name: str, workspace_name: str, workspace: _models.Workspace, *, content_type: str = 'application/json', **kwargs: Any) → _models.Workspace[source]¶

create_or_update(resource_group_name: str, workspace_name: str, workspace: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Workspace

Create or update a workspace.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
workspace (Workspace or IO[bytes]) – Object containing Workspace definitions. Is either a Workspace type or a IO[bytes] type. Required.

Returns:

Workspace or the result of cls(response)

Return type:

Raises:

HttpResponseError –

delete(resource_group_name: str, workspace_name: str, **kwargs: Any) → None[source]¶

Remove a workspace.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, workspace_name: str, **kwargs: Any) → Workspace[source]¶

Get a workspace.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Returns:

Workspace or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, page_size: int | None = None, is_descending: bool | None = None, initial_skip: int | None = None, **kwargs: Any) → Iterable[Workspace][source]¶

List workspaces.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
page_size (int) – Number of items per page. Default value is None.
is_descending (bool) – Indicates whether the collection is descending. Default value is None.
initial_skip (int) – Initial number of items to skip. Default value is None.

Returns:

An iterator like instance of either Workspace or the result of cls(response)

Return type:

ItemPaged[Workspace]

Raises:

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[Workspace][source]¶

List workspaces in subscription.

Returns:: An iterator like instance of either Workspace or the result of cls(response)
Return type:: ItemPaged[Workspace]
Raises:: HttpResponseError –

update(resource_group_name: str, workspace_name: str, workspace: _models.WorkspacePatch | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Workspace[source]¶

update(resource_group_name: str, workspace_name: str, workspace: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Workspace

Update a workspace.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
workspace (WorkspacePatch or IO[bytes]) – Object containing Workspace definitions. Is either a WorkspacePatch type or a IO[bytes] type. Default value is None.

Returns:

Workspace or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.desktopvirtualization.models' from '/mnt/vss/_work/1/s/sdk/desktopvirtualization/azure-mgmt-desktopvirtualization/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/desktopvirtualization/models/__init__.py'>¶