azure.mgmt.desktopvirtualization.models module

class azure.mgmt.desktopvirtualization.models.AgentUpdatePatchProperties(*, type: str | _models.SessionHostComponentUpdateType | None = None, use_session_host_local_time: bool | None = None, maintenance_window_time_zone: str | None = None, maintenance_windows: List[_models.MaintenanceWindowPatchProperties] | None = None, **kwargs: Any)[source]

Bases: Model

The session host configuration for updating agent, monitoring agent, and stack component.

Variables:
Keyword Arguments:
class azure.mgmt.desktopvirtualization.models.AgentUpdateProperties(*, type: str | _models.SessionHostComponentUpdateType | None = None, use_session_host_local_time: bool | None = None, maintenance_window_time_zone: str | None = None, maintenance_windows: List[_models.MaintenanceWindowProperties] | None = None, **kwargs: Any)[source]

Bases: Model

The session host configuration for updating agent, monitoring agent, and stack component.

Variables:
Keyword Arguments:
class azure.mgmt.desktopvirtualization.models.AppAttachPackage(*, location: str, properties: _models.AppAttachPackageProperties, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Schema for App Attach Package properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (AppAttachPackageProperties) – Detailed properties for App Attach Package. Required.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (AppAttachPackageProperties) – Detailed properties for App Attach Package. Required.

class azure.mgmt.desktopvirtualization.models.AppAttachPackageArchitectures(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Possible device architectures that an app attach package can be configured for.

ALL = 'ALL'
ARM = 'ARM'
ARM64 = 'ARM64'
NEUTRAL = 'Neutral'
X64 = 'x64'
X86 = 'x86'
X86_A64 = 'x86a64'
class azure.mgmt.desktopvirtualization.models.AppAttachPackageInfoProperties(*, package_alias: str | None = None, image_path: str | None = None, package_name: str | None = None, package_family_name: str | None = None, package_full_name: str | None = None, display_name: str | None = None, package_relative_path: str | None = None, is_regular_registration: bool | None = None, is_active: bool | None = None, package_dependencies: List[_models.MsixPackageDependencies] | None = None, version: str | None = None, last_updated: datetime | None = None, package_applications: List[_models.MsixPackageApplications] | None = None, certificate_name: str | None = None, certificate_expiry: datetime | None = None, is_package_timestamped: str | _models.PackageTimestamped | None = None, **kwargs: Any)[source]

Bases: Model

Schema for Import Package Information properties.

Variables:

  • package_alias (str) – Alias of App Attach Package. Assigned at import time.

  • image_path (str) – VHD/CIM image path on Network Share.

  • package_name (str) – Package Name from appxmanifest.xml.

  • package_family_name (str) – Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.

  • package_full_name (str) – Package Full Name from appxmanifest.xml.

  • display_name (str) – User friendly Name to be displayed in the portal.

  • package_relative_path (str) – Relative Path to the package inside the image.

  • is_regular_registration (bool) – Specifies how to register Package in feed.

  • is_active (bool) – Make this version of the package the active one across the hostpool.

  • package_dependencies (list[MsixPackageDependencies]) – List of package dependencies.

  • version (str) – Package version found in the appxmanifest.xml.

  • last_updated (datetime) – Date Package was last updated, found in the appxmanifest.xml.

  • package_applications (list[MsixPackageApplications]) – List of package applications.

  • certificate_name (str) – Certificate name found in the appxmanifest.xml.

  • certificate_expiry (datetime) – Date certificate expires, found in the appxmanifest.xml.

  • is_package_timestamped (str or PackageTimestamped) – Is package timestamped so it can ignore the certificate expiry date. Known values are: “Timestamped” and “NotTimestamped”.

Keyword Arguments:

  • package_alias (str) – Alias of App Attach Package. Assigned at import time.

  • image_path (str) – VHD/CIM image path on Network Share.

  • package_name (str) – Package Name from appxmanifest.xml.

  • package_family_name (str) – Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.

  • package_full_name (str) – Package Full Name from appxmanifest.xml.

  • display_name (str) – User friendly Name to be displayed in the portal.

  • package_relative_path (str) – Relative Path to the package inside the image.

  • is_regular_registration (bool) – Specifies how to register Package in feed.

  • is_active (bool) – Make this version of the package the active one across the hostpool.

  • package_dependencies (list[MsixPackageDependencies]) – List of package dependencies.

  • version (str) – Package version found in the appxmanifest.xml.

  • last_updated (datetime) – Date Package was last updated, found in the appxmanifest.xml.

  • package_applications (list[MsixPackageApplications]) – List of package applications.

  • certificate_name (str) – Certificate name found in the appxmanifest.xml.

  • certificate_expiry (datetime) – Date certificate expires, found in the appxmanifest.xml.

  • is_package_timestamped (str or PackageTimestamped) – Is package timestamped so it can ignore the certificate expiry date. Known values are: “Timestamped” and “NotTimestamped”.

class azure.mgmt.desktopvirtualization.models.AppAttachPackageList(*, value: List[_models.AppAttachPackage] | None = None, **kwargs: Any)[source]

Bases: Model

List of App Attach Package definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[AppAttachPackage]) – List of App Attach Package definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[AppAttachPackage]) – List of App Attach Package definitions.

class azure.mgmt.desktopvirtualization.models.AppAttachPackagePatch(*, properties: _models.AppAttachPackagePatchProperties | None = None, **kwargs: Any)[source]

Bases: Resource

Schema for updatable App Attach Package properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (AppAttachPackagePatchProperties) – Detailed properties for App Attach Package.

Keyword Arguments:

properties (AppAttachPackagePatchProperties) – Detailed properties for App Attach Package.

class azure.mgmt.desktopvirtualization.models.AppAttachPackagePatchProperties(*, image: _models.AppAttachPackageInfoProperties | None = None, host_pool_references: List[str] | None = None, key_vault_url: str | None = None, fail_health_check_on_staging_failure: str | _models.FailHealthCheckOnStagingFailure | None = None, **kwargs: Any)[source]

Bases: Model

Schema for patchable fields on an App Attach Package.

Variables:

  • image (AppAttachPackageInfoProperties) – Detailed properties for App Attach Package.

  • host_pool_references (list[str]) – List of Hostpool resource Ids.

  • key_vault_url (str) – URL path to certificate name located in keyVault.

  • fail_health_check_on_staging_failure (str or FailHealthCheckOnStagingFailure) – Parameter indicating how the health check should behave if this package fails staging. Known values are: “Unhealthy”, “NeedsAssistance”, and “DoNotFail”.

Keyword Arguments:

  • image (AppAttachPackageInfoProperties) – Detailed properties for App Attach Package.

  • host_pool_references (list[str]) – List of Hostpool resource Ids.

  • key_vault_url (str) – URL path to certificate name located in keyVault.

  • fail_health_check_on_staging_failure (str or FailHealthCheckOnStagingFailure) – Parameter indicating how the health check should behave if this package fails staging. Known values are: “Unhealthy”, “NeedsAssistance”, and “DoNotFail”.

class azure.mgmt.desktopvirtualization.models.AppAttachPackageProperties(*, image: _models.AppAttachPackageInfoProperties | None = None, host_pool_references: List[str] | None = None, key_vault_url: str | None = None, fail_health_check_on_staging_failure: str | _models.FailHealthCheckOnStagingFailure | None = None, **kwargs: Any)[source]

Bases: Model

Schema for App Attach Package properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • provisioning_state (str or ProvisioningState) – The provisioning state of the App Attach Package. Known values are: “Succeeded”, “Provisioning”, “Failed”, and “Canceled”.

  • image (AppAttachPackageInfoProperties) – Detailed properties for App Attach Package.

  • host_pool_references (list[str]) – List of Hostpool resource Ids.

  • key_vault_url (str) – URL path to certificate name located in keyVault.

  • fail_health_check_on_staging_failure (str or FailHealthCheckOnStagingFailure) – Parameter indicating how the health check should behave if this package fails staging. Known values are: “Unhealthy”, “NeedsAssistance”, and “DoNotFail”.

Keyword Arguments:

  • image (AppAttachPackageInfoProperties) – Detailed properties for App Attach Package.

  • host_pool_references (list[str]) – List of Hostpool resource Ids.

  • key_vault_url (str) – URL path to certificate name located in keyVault.

  • fail_health_check_on_staging_failure (str or FailHealthCheckOnStagingFailure) – Parameter indicating how the health check should behave if this package fails staging. Known values are: “Unhealthy”, “NeedsAssistance”, and “DoNotFail”.

class azure.mgmt.desktopvirtualization.models.Application(*, command_line_setting: str | _models.CommandLineSetting, description: str | None = None, friendly_name: str | None = None, file_path: str | None = None, msix_package_family_name: str | None = None, msix_package_application_id: str | None = None, application_type: str | _models.RemoteApplicationType | None = None, command_line_arguments: str | None = None, show_in_portal: bool | None = None, icon_path: str | None = None, icon_index: int | None = None, **kwargs: Any)[source]

Bases: Resource

Schema for Application properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • object_id (str) – ObjectId of Application. (internal use).

  • description (str) – Description of Application.

  • friendly_name (str) – Friendly name of Application.

  • file_path (str) – Specifies a path for the executable file for the application.

  • msix_package_family_name (str) – Specifies the package family name for MSIX applications.

  • msix_package_application_id (str) – Specifies the package application Id for MSIX applications.

  • application_type (str or RemoteApplicationType) – Resource Type of Application. Known values are: “InBuilt” and “MsixApplication”.

  • command_line_setting (str or CommandLineSetting) – Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. Required. Known values are: “DoNotAllow”, “Allow”, and “Require”.

  • command_line_arguments (str) – Command Line Arguments for Application.

  • show_in_portal (bool) – Specifies whether to show the RemoteApp program in the RD Web Access server.

  • icon_path (str) – Path to icon.

  • icon_index (int) – Index of the icon.

  • icon_hash (str) – Hash of the icon.

  • icon_content (bytes) – the icon a 64 bit string as a byte array.

Keyword Arguments:

  • description (str) – Description of Application.

  • friendly_name (str) – Friendly name of Application.

  • file_path (str) – Specifies a path for the executable file for the application.

  • msix_package_family_name (str) – Specifies the package family name for MSIX applications.

  • msix_package_application_id (str) – Specifies the package application Id for MSIX applications.

  • application_type (str or RemoteApplicationType) – Resource Type of Application. Known values are: “InBuilt” and “MsixApplication”.

  • command_line_setting (str or CommandLineSetting) – Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. Required. Known values are: “DoNotAllow”, “Allow”, and “Require”.

  • command_line_arguments (str) – Command Line Arguments for Application.

  • show_in_portal (bool) – Specifies whether to show the RemoteApp program in the RD Web Access server.

  • icon_path (str) – Path to icon.

  • icon_index (int) – Index of the icon.

class azure.mgmt.desktopvirtualization.models.ApplicationGroup(*, location: str, host_pool_arm_path: str, application_group_type: str | _models.ApplicationGroupType, tags: Dict[str, str] | None = None, managed_by: str | None = None, kind: str | None = None, identity: _models.ResourceModelWithAllowedPropertySetIdentity | None = None, sku: _models.ResourceModelWithAllowedPropertySetSku | None = None, plan: _models.ResourceModelWithAllowedPropertySetPlan | None = None, description: str | None = None, friendly_name: str | None = None, show_in_feed: bool | None = None, **kwargs: Any)[source]

Bases: ResourceModelWithAllowedPropertySet

Represents a ApplicationGroup definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • etag (str) – The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • object_id (str) – ObjectId of ApplicationGroup. (internal use).

  • description (str) – Description of ApplicationGroup.

  • friendly_name (str) – Friendly name of ApplicationGroup.

  • host_pool_arm_path (str) – HostPool arm path of ApplicationGroup. Required.

  • workspace_arm_path (str) – Workspace arm path of ApplicationGroup.

  • application_group_type (str or ApplicationGroupType) – Resource Type of ApplicationGroup. Required. Known values are: “RemoteApp” and “Desktop”.

  • cloud_pc_resource (bool) – Is cloud pc resource.

  • show_in_feed (bool) – Boolean representing whether the applicationGroup is show in the feed.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • description (str) – Description of ApplicationGroup.

  • friendly_name (str) – Friendly name of ApplicationGroup.

  • host_pool_arm_path (str) – HostPool arm path of ApplicationGroup. Required.

  • application_group_type (str or ApplicationGroupType) – Resource Type of ApplicationGroup. Required. Known values are: “RemoteApp” and “Desktop”.

  • show_in_feed (bool) – Boolean representing whether the applicationGroup is show in the feed.

class azure.mgmt.desktopvirtualization.models.ApplicationGroupList(*, value: List[_models.ApplicationGroup] | None = None, **kwargs: Any)[source]

Bases: Model

List of ApplicationGroup definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ApplicationGroup]) – List of ApplicationGroup definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[ApplicationGroup]) – List of ApplicationGroup definitions.

class azure.mgmt.desktopvirtualization.models.ApplicationGroupPatch(*, tags: Dict[str, str] | None = None, description: str | None = None, friendly_name: str | None = None, show_in_feed: bool | None = None, **kwargs: Any)[source]

Bases: Resource

ApplicationGroup properties that can be patched.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of ApplicationGroup.

  • friendly_name (str) – Friendly name of ApplicationGroup.

  • show_in_feed (bool) – Boolean representing whether the applicationGroup is show in the feed.

Keyword Arguments:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of ApplicationGroup.

  • friendly_name (str) – Friendly name of ApplicationGroup.

  • show_in_feed (bool) – Boolean representing whether the applicationGroup is show in the feed.

class azure.mgmt.desktopvirtualization.models.ApplicationGroupType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Resource Type of ApplicationGroup.

DESKTOP = 'Desktop'
REMOTE_APP = 'RemoteApp'
class azure.mgmt.desktopvirtualization.models.ApplicationList(*, value: List[_models.Application] | None = None, **kwargs: Any)[source]

Bases: Model

List of Application definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[Application]) – List of Application definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[Application]) – List of Application definitions.

class azure.mgmt.desktopvirtualization.models.ApplicationPatch(*, tags: Dict[str, str] | None = None, description: str | None = None, friendly_name: str | None = None, file_path: str | None = None, command_line_setting: str | _models.CommandLineSetting | None = None, command_line_arguments: str | None = None, show_in_portal: bool | None = None, icon_path: str | None = None, icon_index: int | None = None, msix_package_family_name: str | None = None, msix_package_application_id: str | None = None, application_type: str | _models.RemoteApplicationType | None = None, **kwargs: Any)[source]

Bases: Model

Application properties that can be patched.

Variables:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of Application.

  • friendly_name (str) – Friendly name of Application.

  • file_path (str) – Specifies a path for the executable file for the application.

  • command_line_setting (str or CommandLineSetting) – Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. Known values are: “DoNotAllow”, “Allow”, and “Require”.

  • command_line_arguments (str) – Command Line Arguments for Application.

  • show_in_portal (bool) – Specifies whether to show the RemoteApp program in the RD Web Access server.

  • icon_path (str) – Path to icon.

  • icon_index (int) – Index of the icon.

  • msix_package_family_name (str) – Specifies the package family name for MSIX applications.

  • msix_package_application_id (str) – Specifies the package application Id for MSIX applications.

  • application_type (str or RemoteApplicationType) – Resource Type of Application. Known values are: “InBuilt” and “MsixApplication”.

Keyword Arguments:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of Application.

  • friendly_name (str) – Friendly name of Application.

  • file_path (str) – Specifies a path for the executable file for the application.

  • command_line_setting (str or CommandLineSetting) – Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. Known values are: “DoNotAllow”, “Allow”, and “Require”.

  • command_line_arguments (str) – Command Line Arguments for Application.

  • show_in_portal (bool) – Specifies whether to show the RemoteApp program in the RD Web Access server.

  • icon_path (str) – Path to icon.

  • icon_index (int) – Index of the icon.

  • msix_package_family_name (str) – Specifies the package family name for MSIX applications.

  • msix_package_application_id (str) – Specifies the package application Id for MSIX applications.

  • application_type (str or RemoteApplicationType) – Resource Type of Application. Known values are: “InBuilt” and “MsixApplication”.

class azure.mgmt.desktopvirtualization.models.ApplicationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Application type of application.

DESKTOP = 'Desktop'
REMOTE_APP = 'RemoteApp'
class azure.mgmt.desktopvirtualization.models.CloudErrorProperties(*, code: str | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: Model

Cloud error object properties.

Variables:

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

Keyword Arguments:

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

class azure.mgmt.desktopvirtualization.models.CommandLineSetting(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.

ALLOW = 'Allow'
DO_NOT_ALLOW = 'DoNotAllow'
REQUIRE = 'Require'
class azure.mgmt.desktopvirtualization.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.desktopvirtualization.models.DayOfWeek(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Day of the week.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.desktopvirtualization.models.Desktop(*, description: str | None = None, friendly_name: str | None = None, **kwargs: Any)[source]

Bases: Resource

Schema for Desktop properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • object_id (str) – ObjectId of Desktop. (internal use).

  • description (str) – Description of Desktop.

  • friendly_name (str) – Friendly name of Desktop.

  • icon_hash (str) – Hash of the icon.

  • icon_content (bytes) – The icon a 64 bit string as a byte array.

Keyword Arguments:

  • description (str) – Description of Desktop.

  • friendly_name (str) – Friendly name of Desktop.

class azure.mgmt.desktopvirtualization.models.DesktopList(*, value: List[_models.Desktop] | None = None, **kwargs: Any)[source]

Bases: Model

List of Desktop definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[Desktop]) – List of Desktop definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[Desktop]) – List of Desktop definitions.

class azure.mgmt.desktopvirtualization.models.DesktopPatch(*, tags: Dict[str, str] | None = None, description: str | None = None, friendly_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Desktop properties that can be patched.

Variables:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of Desktop.

  • friendly_name (str) – Friendly name of Desktop.

Keyword Arguments:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of Desktop.

  • friendly_name (str) – Friendly name of Desktop.

class azure.mgmt.desktopvirtualization.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

class azure.mgmt.desktopvirtualization.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.desktopvirtualization.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:

error (ErrorDetail) – The error object.

Keyword Arguments:

error (ErrorDetail) – The error object.

class azure.mgmt.desktopvirtualization.models.ExpandMsixImage(*, package_alias: str | None = None, image_path: str | None = None, package_name: str | None = None, package_family_name: str | None = None, package_full_name: str | None = None, display_name: str | None = None, package_relative_path: str | None = None, is_regular_registration: bool | None = None, is_active: bool | None = None, package_dependencies: List[_models.MsixPackageDependencies] | None = None, version: str | None = None, last_updated: datetime | None = None, package_applications: List[_models.MsixPackageApplications] | None = None, certificate_name: str | None = None, certificate_expiry: datetime | None = None, **kwargs: Any)[source]

Bases: Resource

Represents the definition of contents retrieved after expanding the MSIX Image.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • package_alias (str) – Alias of MSIX Package.

  • image_path (str) – VHD/CIM image path on Network Share.

  • package_name (str) – Package Name from appxmanifest.xml.

  • package_family_name (str) – Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.

  • package_full_name (str) – Package Full Name from appxmanifest.xml.

  • display_name (str) – User friendly Name to be displayed in the portal.

  • package_relative_path (str) – Relative Path to the package inside the image.

  • is_regular_registration (bool) – Specifies how to register Package in feed.

  • is_active (bool) – Make this version of the package the active one across the hostpool.

  • package_dependencies (list[MsixPackageDependencies]) – List of package dependencies.

  • version (str) – Package version found in the appxmanifest.xml.

  • last_updated (datetime) – Date Package was last updated, found in the appxmanifest.xml.

  • package_applications (list[MsixPackageApplications]) – List of package applications.

  • certificate_name (str) – Certificate name found in the appxmanifest.xml.

  • certificate_expiry (datetime) – Date certificate expires, found in the appxmanifest.xml.

Keyword Arguments:

  • package_alias (str) – Alias of MSIX Package.

  • image_path (str) – VHD/CIM image path on Network Share.

  • package_name (str) – Package Name from appxmanifest.xml.

  • package_family_name (str) – Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.

  • package_full_name (str) – Package Full Name from appxmanifest.xml.

  • display_name (str) – User friendly Name to be displayed in the portal.

  • package_relative_path (str) – Relative Path to the package inside the image.

  • is_regular_registration (bool) – Specifies how to register Package in feed.

  • is_active (bool) – Make this version of the package the active one across the hostpool.

  • package_dependencies (list[MsixPackageDependencies]) – List of package dependencies.

  • version (str) – Package version found in the appxmanifest.xml.

  • last_updated (datetime) – Date Package was last updated, found in the appxmanifest.xml.

  • package_applications (list[MsixPackageApplications]) – List of package applications.

  • certificate_name (str) – Certificate name found in the appxmanifest.xml.

  • certificate_expiry (datetime) – Date certificate expires, found in the appxmanifest.xml.

class azure.mgmt.desktopvirtualization.models.ExpandMsixImageList(*, value: List[_models.ExpandMsixImage] | None = None, **kwargs: Any)[source]

Bases: Model

List of MSIX package properties retrieved from MSIX Image expansion.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ExpandMsixImage]) – List of MSIX package properties from give MSIX Image.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[ExpandMsixImage]) – List of MSIX package properties from give MSIX Image.

class azure.mgmt.desktopvirtualization.models.FailHealthCheckOnStagingFailure(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Parameter indicating how the health check should behave if this package fails staging.

DO_NOT_FAIL = 'DoNotFail'
NEEDS_ASSISTANCE = 'NeedsAssistance'
UNHEALTHY = 'Unhealthy'
class azure.mgmt.desktopvirtualization.models.HealthCheckName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Represents the name of the health check operation performed.

APP_ATTACH_HEALTH_CHECK = 'AppAttachHealthCheck'

Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)

DOMAIN_JOINED_CHECK = 'DomainJoinedCheck'

Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)

DOMAIN_REACHABLE = 'DomainReachable'

Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)

DOMAIN_TRUST_CHECK = 'DomainTrustCheck'

Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)

FS_LOGIX_HEALTH_CHECK = 'FSLogixHealthCheck'

Verifies the FSLogix service is up and running to make sure users’ profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)

META_DATA_SERVICE_CHECK = 'MetaDataServiceCheck'

Verifies the metadata service is accessible and return compute properties. (Currently Enabled)

MONITORING_AGENT_CHECK = 'MonitoringAgentCheck'

Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)

SUPPORTED_ENCRYPTION_CHECK = 'SupportedEncryptionCheck'

Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)

SX_S_STACK_LISTENER_CHECK = 'SxSStackListenerCheck'

Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)

URLS_ACCESSIBLE_CHECK = 'UrlsAccessibleCheck'

Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations …). (Currently Disabled)

WEB_RTC_REDIRECTOR_CHECK = 'WebRTCRedirectorCheck'

Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)

class azure.mgmt.desktopvirtualization.models.HealthCheckResult(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Represents the Health state of the health check we performed.

HEALTH_CHECK_FAILED = 'HealthCheckFailed'

Health check failed.

HEALTH_CHECK_SUCCEEDED = 'HealthCheckSucceeded'

Health check passed.

SESSION_HOST_SHUTDOWN = 'SessionHostShutdown'

We received a Shutdown notification.

UNKNOWN = 'Unknown'

Health check result is not currently known.

class azure.mgmt.desktopvirtualization.models.HostPool(*, location: str, host_pool_type: str | _models.HostPoolType, load_balancer_type: str | _models.LoadBalancerType, preferred_app_group_type: str | _models.PreferredAppGroupType, tags: Dict[str, str] | None = None, managed_by: str | None = None, kind: str | None = None, identity: _models.ResourceModelWithAllowedPropertySetIdentity | None = None, sku: _models.ResourceModelWithAllowedPropertySetSku | None = None, plan: _models.ResourceModelWithAllowedPropertySetPlan | None = None, friendly_name: str | None = None, description: str | None = None, personal_desktop_assignment_type: str | _models.PersonalDesktopAssignmentType | None = None, custom_rdp_property: str | None = None, max_session_limit: int | None = None, ring: int | None = None, validation_environment: bool | None = None, registration_info: _models.RegistrationInfo | None = None, vm_template: str | None = None, ssoadfs_authority: str | None = None, sso_client_id: str | None = None, sso_client_secret_key_vault_path: str | None = None, sso_secret_type: str | _models.SSOSecretType | None = None, start_vm_on_connect: bool | None = None, public_network_access: str | _models.HostpoolPublicNetworkAccess | None = None, agent_update: _models.AgentUpdateProperties | None = None, **kwargs: Any)[source]

Bases: ResourceModelWithAllowedPropertySet

Represents a HostPool definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • etag (str) – The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • object_id (str) – ObjectId of HostPool. (internal use).

  • friendly_name (str) – Friendly name of HostPool.

  • description (str) – Description of HostPool.

  • host_pool_type (str or HostPoolType) – HostPool type for desktop. Required. Known values are: “Personal”, “Pooled”, and “BYODesktop”.

  • personal_desktop_assignment_type (str or PersonalDesktopAssignmentType) – PersonalDesktopAssignment type for HostPool. Known values are: “Automatic” and “Direct”.

  • custom_rdp_property (str) – Custom rdp property of HostPool.

  • max_session_limit (int) – The max session limit of HostPool.

  • load_balancer_type (str or LoadBalancerType) – The type of the load balancer. Required. Known values are: “BreadthFirst”, “DepthFirst”, and “Persistent”.

  • ring (int) – The ring number of HostPool.

  • validation_environment (bool) – Is validation environment.

  • registration_info (RegistrationInfo) – The registration info of HostPool.

  • vm_template (str) – VM template for sessionhosts configuration within hostpool.

  • application_group_references (list[str]) – List of applicationGroup links.

  • app_attach_package_references (list[str]) – List of App Attach Package links.

  • ssoadfs_authority (str) – URL to customer ADFS server for signing WVD SSO certificates.

  • sso_client_id (str) – ClientId for the registered Relying Party used to issue WVD SSO certificates.

  • sso_client_secret_key_vault_path (str) – Path to Azure KeyVault storing the secret used for communication to ADFS.

  • sso_secret_type (str or SSOSecretType) – The type of single sign on Secret Type. Known values are: “SharedKey”, “Certificate”, “SharedKeyInKeyVault”, and “CertificateInKeyVault”.

  • preferred_app_group_type (str or PreferredAppGroupType) – The type of preferred application group type, default to Desktop Application Group. Required. Known values are: “None”, “Desktop”, and “RailApplications”.

  • start_vm_on_connect (bool) – The flag to turn on/off StartVMOnConnect feature.

  • cloud_pc_resource (bool) – Is cloud pc resource.

  • public_network_access (str or HostpoolPublicNetworkAccess) – Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: “Enabled”, “Disabled”, “EnabledForSessionHostsOnly”, and “EnabledForClientsOnly”.

  • agent_update (AgentUpdateProperties) – The session host configuration for updating agent, monitoring agent, and stack component.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connection associated with the specified resource.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • friendly_name (str) – Friendly name of HostPool.

  • description (str) – Description of HostPool.

  • host_pool_type (str or HostPoolType) – HostPool type for desktop. Required. Known values are: “Personal”, “Pooled”, and “BYODesktop”.

  • personal_desktop_assignment_type (str or PersonalDesktopAssignmentType) – PersonalDesktopAssignment type for HostPool. Known values are: “Automatic” and “Direct”.

  • custom_rdp_property (str) – Custom rdp property of HostPool.

  • max_session_limit (int) – The max session limit of HostPool.

  • load_balancer_type (str or LoadBalancerType) – The type of the load balancer. Required. Known values are: “BreadthFirst”, “DepthFirst”, and “Persistent”.

  • ring (int) – The ring number of HostPool.

  • validation_environment (bool) – Is validation environment.

  • registration_info (RegistrationInfo) – The registration info of HostPool.

  • vm_template (str) – VM template for sessionhosts configuration within hostpool.

  • ssoadfs_authority (str) – URL to customer ADFS server for signing WVD SSO certificates.

  • sso_client_id (str) – ClientId for the registered Relying Party used to issue WVD SSO certificates.

  • sso_client_secret_key_vault_path (str) – Path to Azure KeyVault storing the secret used for communication to ADFS.

  • sso_secret_type (str or SSOSecretType) – The type of single sign on Secret Type. Known values are: “SharedKey”, “Certificate”, “SharedKeyInKeyVault”, and “CertificateInKeyVault”.

  • preferred_app_group_type (str or PreferredAppGroupType) – The type of preferred application group type, default to Desktop Application Group. Required. Known values are: “None”, “Desktop”, and “RailApplications”.

  • start_vm_on_connect (bool) – The flag to turn on/off StartVMOnConnect feature.

  • public_network_access (str or HostpoolPublicNetworkAccess) – Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: “Enabled”, “Disabled”, “EnabledForSessionHostsOnly”, and “EnabledForClientsOnly”.

  • agent_update (AgentUpdateProperties) – The session host configuration for updating agent, monitoring agent, and stack component.

class azure.mgmt.desktopvirtualization.models.HostPoolList(*, value: List[_models.HostPool] | None = None, **kwargs: Any)[source]

Bases: Model

List of HostPool definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[HostPool]) – List of HostPool definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[HostPool]) – List of HostPool definitions.

class azure.mgmt.desktopvirtualization.models.HostPoolPatch(*, tags: Dict[str, str] | None = None, friendly_name: str | None = None, description: str | None = None, custom_rdp_property: str | None = None, max_session_limit: int | None = None, personal_desktop_assignment_type: str | _models.PersonalDesktopAssignmentType | None = None, load_balancer_type: str | _models.LoadBalancerType | None = None, ring: int | None = None, validation_environment: bool | None = None, registration_info: _models.RegistrationInfoPatch | None = None, vm_template: str | None = None, ssoadfs_authority: str | None = None, sso_client_id: str | None = None, sso_client_secret_key_vault_path: str | None = None, sso_secret_type: str | _models.SSOSecretType | None = None, preferred_app_group_type: str | _models.PreferredAppGroupType | None = None, start_vm_on_connect: bool | None = None, public_network_access: str | _models.HostpoolPublicNetworkAccess | None = None, agent_update: _models.AgentUpdatePatchProperties | None = None, **kwargs: Any)[source]

Bases: Resource

HostPool properties that can be patched.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – tags to be updated.

  • friendly_name (str) – Friendly name of HostPool.

  • description (str) – Description of HostPool.

  • custom_rdp_property (str) – Custom rdp property of HostPool.

  • max_session_limit (int) – The max session limit of HostPool.

  • personal_desktop_assignment_type (str or PersonalDesktopAssignmentType) – PersonalDesktopAssignment type for HostPool. Known values are: “Automatic” and “Direct”.

  • load_balancer_type (str or LoadBalancerType) – The type of the load balancer. Known values are: “BreadthFirst”, “DepthFirst”, and “Persistent”.

  • ring (int) – The ring number of HostPool.

  • validation_environment (bool) – Is validation environment.

  • registration_info (RegistrationInfoPatch) – The registration info of HostPool.

  • vm_template (str) – VM template for sessionhosts configuration within hostpool.

  • ssoadfs_authority (str) – URL to customer ADFS server for signing WVD SSO certificates.

  • sso_client_id (str) – ClientId for the registered Relying Party used to issue WVD SSO certificates.

  • sso_client_secret_key_vault_path (str) – Path to Azure KeyVault storing the secret used for communication to ADFS.

  • sso_secret_type (str or SSOSecretType) – The type of single sign on Secret Type. Known values are: “SharedKey”, “Certificate”, “SharedKeyInKeyVault”, and “CertificateInKeyVault”.

  • preferred_app_group_type (str or PreferredAppGroupType) – The type of preferred application group type, default to Desktop Application Group. Known values are: “None”, “Desktop”, and “RailApplications”.

  • start_vm_on_connect (bool) – The flag to turn on/off StartVMOnConnect feature.

  • public_network_access (str or HostpoolPublicNetworkAccess) – Enabled to allow this resource to be access from the public network. Known values are: “Enabled”, “Disabled”, “EnabledForSessionHostsOnly”, and “EnabledForClientsOnly”.

  • agent_update (AgentUpdatePatchProperties) – The session host configuration for updating agent, monitoring agent, and stack component.

Keyword Arguments:

  • tags (dict[str, str]) – tags to be updated.

  • friendly_name (str) – Friendly name of HostPool.

  • description (str) – Description of HostPool.

  • custom_rdp_property (str) – Custom rdp property of HostPool.

  • max_session_limit (int) – The max session limit of HostPool.

  • personal_desktop_assignment_type (str or PersonalDesktopAssignmentType) – PersonalDesktopAssignment type for HostPool. Known values are: “Automatic” and “Direct”.

  • load_balancer_type (str or LoadBalancerType) – The type of the load balancer. Known values are: “BreadthFirst”, “DepthFirst”, and “Persistent”.

  • ring (int) – The ring number of HostPool.

  • validation_environment (bool) – Is validation environment.

  • registration_info (RegistrationInfoPatch) – The registration info of HostPool.

  • vm_template (str) – VM template for sessionhosts configuration within hostpool.

  • ssoadfs_authority (str) – URL to customer ADFS server for signing WVD SSO certificates.

  • sso_client_id (str) – ClientId for the registered Relying Party used to issue WVD SSO certificates.

  • sso_client_secret_key_vault_path (str) – Path to Azure KeyVault storing the secret used for communication to ADFS.

  • sso_secret_type (str or SSOSecretType) – The type of single sign on Secret Type. Known values are: “SharedKey”, “Certificate”, “SharedKeyInKeyVault”, and “CertificateInKeyVault”.

  • preferred_app_group_type (str or PreferredAppGroupType) – The type of preferred application group type, default to Desktop Application Group. Known values are: “None”, “Desktop”, and “RailApplications”.

  • start_vm_on_connect (bool) – The flag to turn on/off StartVMOnConnect feature.

  • public_network_access (str or HostpoolPublicNetworkAccess) – Enabled to allow this resource to be access from the public network. Known values are: “Enabled”, “Disabled”, “EnabledForSessionHostsOnly”, and “EnabledForClientsOnly”.

  • agent_update (AgentUpdatePatchProperties) – The session host configuration for updating agent, monitoring agent, and stack component.

class azure.mgmt.desktopvirtualization.models.HostPoolType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

HostPool type for desktop.

BYO_DESKTOP = 'BYODesktop'

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

PERSONAL = 'Personal'

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

POOLED = 'Pooled'

Users get a new (random) SessionHost every time it connects to the HostPool.

class azure.mgmt.desktopvirtualization.models.HostpoolPublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
ENABLED_FOR_CLIENTS_ONLY = 'EnabledForClientsOnly'
ENABLED_FOR_SESSION_HOSTS_ONLY = 'EnabledForSessionHostsOnly'
class azure.mgmt.desktopvirtualization.models.Identity(*, type: Literal['SystemAssigned'] | None = None, **kwargs: Any)[source]

Bases: Model

Identity for the resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The principal ID of resource identity. The value must be an UUID.

  • tenant_id (str) – The tenant ID of resource. The value must be an UUID.

  • type (str) – The identity type. Default value is “SystemAssigned”.

Keyword Arguments:

type (str) – The identity type. Default value is “SystemAssigned”.

class azure.mgmt.desktopvirtualization.models.ImportPackageInfoRequest(*, path: str | None = None, package_architecture: str | _models.AppAttachPackageArchitectures | None = None, **kwargs: Any)[source]

Bases: Model

Information to import app attach package.

Variables:

  • path (str) – URI to Image.

  • package_architecture (str or AppAttachPackageArchitectures) – Possible device architectures that an app attach package can be configured for. Known values are: “ARM”, “ARM64”, “x86”, “x64”, “Neutral”, “x86a64”, and “ALL”.

Keyword Arguments:

  • path (str) – URI to Image.

  • package_architecture (str or AppAttachPackageArchitectures) – Possible device architectures that an app attach package can be configured for. Known values are: “ARM”, “ARM64”, “x86”, “x64”, “Neutral”, “x86a64”, and “ALL”.

class azure.mgmt.desktopvirtualization.models.LoadBalancerType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of the load balancer.

BREADTH_FIRST = 'BreadthFirst'
DEPTH_FIRST = 'DepthFirst'
PERSISTENT = 'Persistent'
class azure.mgmt.desktopvirtualization.models.LogSpecification(*, name: str | None = None, display_name: str | None = None, blob_duration: str | None = None, **kwargs: Any)[source]

Bases: Model

Specifications of the Log for Azure Monitoring.

Variables:

  • name (str) – Name of the log.

  • display_name (str) – Localized friendly display name of the log.

  • blob_duration (str) – Blob duration of the log.

Keyword Arguments:

  • name (str) – Name of the log.

  • display_name (str) – Localized friendly display name of the log.

  • blob_duration (str) – Blob duration of the log.

class azure.mgmt.desktopvirtualization.models.MSIXImageURI(*, uri: str | None = None, **kwargs: Any)[source]

Bases: Model

Represents URI referring to MSIX Image.

Variables:

uri (str) – URI to Image.

Keyword Arguments:

uri (str) – URI to Image.

class azure.mgmt.desktopvirtualization.models.MSIXPackage(*, image_path: str | None = None, package_name: str | None = None, package_family_name: str | None = None, display_name: str | None = None, package_relative_path: str | None = None, is_regular_registration: bool | None = None, is_active: bool | None = None, package_dependencies: List[_models.MsixPackageDependencies] | None = None, version: str | None = None, last_updated: datetime | None = None, package_applications: List[_models.MsixPackageApplications] | None = None, **kwargs: Any)[source]

Bases: Resource

Schema for MSIX Package properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • image_path (str) – VHD/CIM image path on Network Share.

  • package_name (str) – Package Name from appxmanifest.xml.

  • package_family_name (str) – Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.

  • display_name (str) – User friendly Name to be displayed in the portal.

  • package_relative_path (str) – Relative Path to the package inside the image.

  • is_regular_registration (bool) – Specifies how to register Package in feed.

  • is_active (bool) – Make this version of the package the active one across the hostpool.

  • package_dependencies (list[MsixPackageDependencies]) – List of package dependencies.

  • version (str) – Package version found in the appxmanifest.xml.

  • last_updated (datetime) – Date Package was last updated, found in the appxmanifest.xml.

  • package_applications (list[MsixPackageApplications]) – List of package applications.

Keyword Arguments:

  • image_path (str) – VHD/CIM image path on Network Share.

  • package_name (str) – Package Name from appxmanifest.xml.

  • package_family_name (str) – Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.

  • display_name (str) – User friendly Name to be displayed in the portal.

  • package_relative_path (str) – Relative Path to the package inside the image.

  • is_regular_registration (bool) – Specifies how to register Package in feed.

  • is_active (bool) – Make this version of the package the active one across the hostpool.

  • package_dependencies (list[MsixPackageDependencies]) – List of package dependencies.

  • version (str) – Package version found in the appxmanifest.xml.

  • last_updated (datetime) – Date Package was last updated, found in the appxmanifest.xml.

  • package_applications (list[MsixPackageApplications]) – List of package applications.

class azure.mgmt.desktopvirtualization.models.MSIXPackageList(*, value: List[_models.MSIXPackage] | None = None, **kwargs: Any)[source]

Bases: Model

List of MSIX Package definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[MSIXPackage]) – List of MSIX Package definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[MSIXPackage]) – List of MSIX Package definitions.

class azure.mgmt.desktopvirtualization.models.MSIXPackagePatch(*, is_active: bool | None = None, is_regular_registration: bool | None = None, display_name: str | None = None, **kwargs: Any)[source]

Bases: Resource

MSIX Package properties that can be patched.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • is_active (bool) – Set a version of the package to be active across hostpool.

  • is_regular_registration (bool) – Set Registration mode. Regular or Delayed.

  • display_name (str) – Display name for MSIX Package.

Keyword Arguments:

  • is_active (bool) – Set a version of the package to be active across hostpool.

  • is_regular_registration (bool) – Set Registration mode. Regular or Delayed.

  • display_name (str) – Display name for MSIX Package.

class azure.mgmt.desktopvirtualization.models.MaintenanceWindowPatchProperties(*, hour: int | None = None, day_of_week: str | _models.DayOfWeek | None = None, **kwargs: Any)[source]

Bases: Model

Maintenance window starting hour and day of week.

Variables:

  • hour (int) – The update start hour of the day. (0 - 23).

  • day_of_week (str or DayOfWeek) – Day of the week. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

Keyword Arguments:

  • hour (int) – The update start hour of the day. (0 - 23).

  • day_of_week (str or DayOfWeek) – Day of the week. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

class azure.mgmt.desktopvirtualization.models.MaintenanceWindowProperties(*, hour: int | None = None, day_of_week: str | _models.DayOfWeek | None = None, **kwargs: Any)[source]

Bases: Model

Maintenance window starting hour and day of week.

Variables:

  • hour (int) – The update start hour of the day. (0 - 23).

  • day_of_week (str or DayOfWeek) – Day of the week. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

Keyword Arguments:

  • hour (int) – The update start hour of the day. (0 - 23).

  • day_of_week (str or DayOfWeek) – Day of the week. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

class azure.mgmt.desktopvirtualization.models.MsixPackageApplications(*, app_id: str | None = None, description: str | None = None, app_user_model_id: str | None = None, friendly_name: str | None = None, icon_image_name: str | None = None, raw_icon: bytes | None = None, raw_png: bytes | None = None, **kwargs: Any)[source]

Bases: Model

Schema for MSIX Package Application properties.

Variables:

  • app_id (str) – Package Application Id, found in appxmanifest.xml.

  • description (str) – Description of Package Application.

  • app_user_model_id (str) – Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.

  • friendly_name (str) – User friendly name.

  • icon_image_name (str) – User friendly name.

  • raw_icon (bytes) – the icon a 64 bit string as a byte array.

  • raw_png (bytes) – the icon a 64 bit string as a byte array.

Keyword Arguments:

  • app_id (str) – Package Application Id, found in appxmanifest.xml.

  • description (str) – Description of Package Application.

  • app_user_model_id (str) – Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.

  • friendly_name (str) – User friendly name.

  • icon_image_name (str) – User friendly name.

  • raw_icon (bytes) – the icon a 64 bit string as a byte array.

  • raw_png (bytes) – the icon a 64 bit string as a byte array.

class azure.mgmt.desktopvirtualization.models.MsixPackageDependencies(*, dependency_name: str | None = None, publisher: str | None = None, min_version: str | None = None, **kwargs: Any)[source]

Bases: Model

Schema for MSIX Package Dependencies properties.

Variables:

  • dependency_name (str) – Name of package dependency.

  • publisher (str) – Name of dependency publisher.

  • min_version (str) – Dependency version required.

Keyword Arguments:

  • dependency_name (str) – Name of package dependency.

  • publisher (str) – Name of dependency publisher.

  • min_version (str) – Dependency version required.

class azure.mgmt.desktopvirtualization.models.OperationProperties(*, service_specification: _models.ServiceSpecification | None = None, **kwargs: Any)[source]

Bases: Model

Properties of the operation.

Variables:

service_specification (ServiceSpecification) – Service specification payload.

Keyword Arguments:

service_specification (ServiceSpecification) – Service specification payload.

class azure.mgmt.desktopvirtualization.models.PackageTimestamped(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Is package timestamped so it can ignore the certificate expiry date.

NOT_TIMESTAMPED = 'NotTimestamped'
TIMESTAMPED = 'Timestamped'
class azure.mgmt.desktopvirtualization.models.PersonalDesktopAssignmentType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

PersonalDesktopAssignment type for HostPool.

AUTOMATIC = 'Automatic'
DIRECT = 'Direct'
class azure.mgmt.desktopvirtualization.models.Plan(*, name: str, publisher: str, product: str, promotion_code: str | None = None, version: str | None = None, **kwargs: Any)[source]

Bases: Model

Plan for the resource.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – A user defined name of the 3rd Party Artifact that is being procured. Required.

  • publisher (str) – The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic. Required.

  • product (str) – The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. Required.

  • promotion_code (str) – A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

  • version (str) – The version of the desired product/artifact.

Keyword Arguments:

  • name (str) – A user defined name of the 3rd Party Artifact that is being procured. Required.

  • publisher (str) – The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic. Required.

  • product (str) – The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. Required.

  • promotion_code (str) – A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

  • version (str) – The version of the desired product/artifact.

class azure.mgmt.desktopvirtualization.models.PreferredAppGroupType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of preferred application group type, default to Desktop Application Group.

DESKTOP = 'Desktop'
NONE = 'None'
RAIL_APPLICATIONS = 'RailApplications'
class azure.mgmt.desktopvirtualization.models.PrivateEndpoint(**kwargs: Any)[source]

Bases: Model

The private endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The ARM identifier for private endpoint.

class azure.mgmt.desktopvirtualization.models.PrivateEndpointConnection(*, private_endpoint: _models.PrivateEndpoint | None = None, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState | None = None, **kwargs: Any)[source]

Bases: Resource

The private endpoint connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • group_ids (list[str]) – The group ids for the private endpoint resource.

  • private_endpoint (PrivateEndpoint) – The private endpoint resource.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

  • provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments:

  • private_endpoint (PrivateEndpoint) – The private endpoint resource.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.desktopvirtualization.models.PrivateEndpointConnectionListResultWithSystemData(*, value: List[_models.PrivateEndpointConnectionWithSystemData] | None = None, **kwargs: Any)[source]

Bases: Model

List of private endpoint connection associated with the specified storage account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[PrivateEndpointConnectionWithSystemData]) – Array of private endpoint connections.

class azure.mgmt.desktopvirtualization.models.PrivateEndpointConnectionProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The current provisioning state.

CREATING = 'Creating'
DELETING = 'Deleting'
FAILED = 'Failed'
SUCCEEDED = 'Succeeded'
class azure.mgmt.desktopvirtualization.models.PrivateEndpointConnectionWithSystemData(*, private_endpoint: _models.PrivateEndpoint | None = None, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState | None = None, **kwargs: Any)[source]

Bases: PrivateEndpointConnection

The Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • group_ids (list[str]) – The group ids for the private endpoint resource.

  • private_endpoint (PrivateEndpoint) – The private endpoint resource.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

  • provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments:

  • private_endpoint (PrivateEndpoint) – The private endpoint resource.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.desktopvirtualization.models.PrivateEndpointServiceConnectionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The private endpoint connection status.

APPROVED = 'Approved'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.desktopvirtualization.models.PrivateLinkResource(*, required_zone_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Resource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • group_id (str) – The private link resource group id.

  • required_members (list[str]) – The private link resource required member names.

  • required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments:

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.desktopvirtualization.models.PrivateLinkResourceListResult(*, value: List[_models.PrivateLinkResource] | None = None, **kwargs: Any)[source]

Bases: Model

A list of private link resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.desktopvirtualization.models.PrivateLinkServiceConnectionState(*, status: str | _models.PrivateEndpointServiceConnectionStatus | None = None, description: str | None = None, actions_required: str | None = None, **kwargs: Any)[source]

Bases: Model

A collection of information about the state of the connection between service consumer and provider.

Variables:

  • status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.

  • description (str) – The reason for approval/rejection of the connection.

  • actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments:

  • status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.

  • description (str) – The reason for approval/rejection of the connection.

  • actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.desktopvirtualization.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The current provisioning state.

CANCELED = 'Canceled'
FAILED = 'Failed'
PROVISIONING = 'Provisioning'
SUCCEEDED = 'Succeeded'
class azure.mgmt.desktopvirtualization.models.ProxyResource(**kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.desktopvirtualization.models.PublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.desktopvirtualization.models.RegistrationInfo(*, expiration_time: datetime | None = None, token: str | None = None, registration_token_operation: str | _models.RegistrationTokenOperation | None = None, **kwargs: Any)[source]

Bases: Model

Represents a RegistrationInfo definition.

Variables:

  • expiration_time (datetime) – Expiration time of registration token.

  • token (str) – The registration token base64 encoded string.

  • registration_token_operation (str or RegistrationTokenOperation) – The type of resetting the token. Known values are: “Delete”, “None”, and “Update”.

Keyword Arguments:

  • expiration_time (datetime) – Expiration time of registration token.

  • token (str) – The registration token base64 encoded string.

  • registration_token_operation (str or RegistrationTokenOperation) – The type of resetting the token. Known values are: “Delete”, “None”, and “Update”.

class azure.mgmt.desktopvirtualization.models.RegistrationInfoPatch(*, expiration_time: datetime | None = None, registration_token_operation: str | _models.RegistrationTokenOperation | None = None, **kwargs: Any)[source]

Bases: Model

Represents a RegistrationInfo definition.

Variables:

  • expiration_time (datetime) – Expiration time of registration token.

  • registration_token_operation (str or RegistrationTokenOperation) – The type of resetting the token. Known values are: “Delete”, “None”, and “Update”.

Keyword Arguments:

  • expiration_time (datetime) – Expiration time of registration token.

  • registration_token_operation (str or RegistrationTokenOperation) – The type of resetting the token. Known values are: “Delete”, “None”, and “Update”.

class azure.mgmt.desktopvirtualization.models.RegistrationTokenList(*, value: List[_models.RegistrationTokenMinimal] | None = None, **kwargs: Any)[source]

Bases: Model

List of RegistrationToken definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[RegistrationTokenMinimal]) – List of RegistrationToken definitions.

class azure.mgmt.desktopvirtualization.models.RegistrationTokenMinimal(*, expiration_time: datetime | None = None, token: str | None = None, **kwargs: Any)[source]

Bases: Model

Represents a Minimal set of properties for RegistrationToken definition.

Variables:

  • expiration_time (datetime) – Expiration time of registration token.

  • token (str) – The registration token base64 encoded string.

Keyword Arguments:

  • expiration_time (datetime) – Expiration time of registration token.

  • token (str) – The registration token base64 encoded string.

class azure.mgmt.desktopvirtualization.models.RegistrationTokenOperation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of resetting the token.

DELETE = 'Delete'
NONE = 'None'
UPDATE = 'Update'
class azure.mgmt.desktopvirtualization.models.RemoteApplicationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Resource Type of Application.

IN_BUILT = 'InBuilt'
MSIX_APPLICATION = 'MsixApplication'
class azure.mgmt.desktopvirtualization.models.Resource(**kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySet(*, location: str, tags: Dict[str, str] | None = None, managed_by: str | None = None, kind: str | None = None, identity: _models.ResourceModelWithAllowedPropertySetIdentity | None = None, sku: _models.ResourceModelWithAllowedPropertySetSku | None = None, plan: _models.ResourceModelWithAllowedPropertySetPlan | None = None, **kwargs: Any)[source]

Bases: TrackedResource

The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • etag (str) – The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

class azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity(*, type: Literal['SystemAssigned'] | None = None, **kwargs: Any)[source]

Bases: Identity

ResourceModelWithAllowedPropertySetIdentity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The principal ID of resource identity. The value must be an UUID.

  • tenant_id (str) – The tenant ID of resource. The value must be an UUID.

  • type (str) – The identity type. Default value is “SystemAssigned”.

Keyword Arguments:

type (str) – The identity type. Default value is “SystemAssigned”.

class azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan(*, name: str, publisher: str, product: str, promotion_code: str | None = None, version: str | None = None, **kwargs: Any)[source]

Bases: Plan

ResourceModelWithAllowedPropertySetPlan.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – A user defined name of the 3rd Party Artifact that is being procured. Required.

  • publisher (str) – The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic. Required.

  • product (str) – The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. Required.

  • promotion_code (str) – A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

  • version (str) – The version of the desired product/artifact.

Keyword Arguments:

  • name (str) – A user defined name of the 3rd Party Artifact that is being procured. Required.

  • publisher (str) – The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic. Required.

  • product (str) – The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. Required.

  • promotion_code (str) – A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

  • version (str) – The version of the desired product/artifact.

class azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku(*, name: str, tier: str | _models.SkuTier | None = None, size: str | None = None, family: str | None = None, capacity: int | None = None, **kwargs: Any)[source]

Bases: Sku

ResourceModelWithAllowedPropertySetSku.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The name of the SKU. E.g. P3. It is typically a letter+number code. Required.

  • tier (str or SkuTier) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Known values are: “Free”, “Basic”, “Standard”, and “Premium”.

  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

  • capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Keyword Arguments:

  • name (str) – The name of the SKU. E.g. P3. It is typically a letter+number code. Required.

  • tier (str or SkuTier) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Known values are: “Free”, “Basic”, “Standard”, and “Premium”.

  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

  • capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

class azure.mgmt.desktopvirtualization.models.ResourceProviderOperation(*, name: str | None = None, display: _models.ResourceProviderOperationDisplay | None = None, is_data_action: bool | None = None, properties: _models.OperationProperties | None = None, **kwargs: Any)[source]

Bases: Model

Supported operation of this resource provider.

Variables:
Keyword Arguments:
class azure.mgmt.desktopvirtualization.models.ResourceProviderOperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Display metadata associated with the operation.

Variables:

  • provider (str) – Resource provider: Microsoft Desktop Virtualization.

  • resource (str) – Resource on which the operation is performed.

  • operation (str) – Type of operation: get, read, delete, etc.

  • description (str) – Description of this operation.

Keyword Arguments:

  • provider (str) – Resource provider: Microsoft Desktop Virtualization.

  • resource (str) – Resource on which the operation is performed.

  • operation (str) – Type of operation: get, read, delete, etc.

  • description (str) – Description of this operation.

class azure.mgmt.desktopvirtualization.models.ResourceProviderOperationList(*, value: List[_models.ResourceProviderOperation] | None = None, **kwargs: Any)[source]

Bases: Model

Result of the request to list operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[ResourceProviderOperation]) – List of operations supported by this resource provider.

class azure.mgmt.desktopvirtualization.models.SSOSecretType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of single sign on Secret Type.

CERTIFICATE = 'Certificate'
CERTIFICATE_IN_KEY_VAULT = 'CertificateInKeyVault'
SHARED_KEY = 'SharedKey'
SHARED_KEY_IN_KEY_VAULT = 'SharedKeyInKeyVault'
class azure.mgmt.desktopvirtualization.models.ScalingHostPoolReference(*, host_pool_arm_path: str | None = None, scaling_plan_enabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Scaling plan reference to hostpool.

Variables:

  • host_pool_arm_path (str) – Arm path of referenced hostpool.

  • scaling_plan_enabled (bool) – Is the scaling plan enabled for this hostpool.

Keyword Arguments:

  • host_pool_arm_path (str) – Arm path of referenced hostpool.

  • scaling_plan_enabled (bool) – Is the scaling plan enabled for this hostpool.

class azure.mgmt.desktopvirtualization.models.ScalingHostPoolType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

HostPool type for desktop.

POOLED = 'Pooled'

Users get a new (random) SessionHost every time it connects to the HostPool.

class azure.mgmt.desktopvirtualization.models.ScalingPlan(*, location: str, time_zone: str, tags: Dict[str, str] | None = None, managed_by: str | None = None, kind: str | None = None, identity: _models.ResourceModelWithAllowedPropertySetIdentity | None = None, sku: _models.ResourceModelWithAllowedPropertySetSku | None = None, plan: _models.ResourceModelWithAllowedPropertySetPlan | None = None, description: str | None = None, friendly_name: str | None = None, host_pool_type: str | _models.ScalingHostPoolType = 'Pooled', exclusion_tag: str | None = None, schedules: List[_models.ScalingSchedule] | None = None, host_pool_references: List[_models.ScalingHostPoolReference] | None = None, **kwargs: Any)[source]

Bases: ResourceModelWithAllowedPropertySet

Represents a scaling plan definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • etag (str) – The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • object_id (str) – ObjectId of scaling plan. (internal use).

  • description (str) – Description of scaling plan.

  • friendly_name (str) – User friendly name of scaling plan.

  • time_zone (str) – Timezone of the scaling plan. Required.

  • host_pool_type (str or ScalingHostPoolType) – HostPool type for desktop. “Pooled”

  • exclusion_tag (str) – Exclusion tag for scaling plan.

  • schedules (list[ScalingSchedule]) – List of ScalingPlanPooledSchedule definitions.

  • host_pool_references (list[ScalingHostPoolReference]) – List of ScalingHostPoolReference definitions.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • description (str) – Description of scaling plan.

  • friendly_name (str) – User friendly name of scaling plan.

  • time_zone (str) – Timezone of the scaling plan. Required.

  • host_pool_type (str or ScalingHostPoolType) – HostPool type for desktop. “Pooled”

  • exclusion_tag (str) – Exclusion tag for scaling plan.

  • schedules (list[ScalingSchedule]) – List of ScalingPlanPooledSchedule definitions.

  • host_pool_references (list[ScalingHostPoolReference]) – List of ScalingHostPoolReference definitions.

class azure.mgmt.desktopvirtualization.models.ScalingPlanList(*, value: List[_models.ScalingPlan] | None = None, **kwargs: Any)[source]

Bases: Model

List of scaling plan definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ScalingPlan]) – List of scaling plan definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[ScalingPlan]) – List of scaling plan definitions.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPatch(*, tags: Dict[str, str] | None = None, description: str | None = None, friendly_name: str | None = None, time_zone: str | None = None, exclusion_tag: str | None = None, schedules: List[_models.ScalingSchedule] | None = None, host_pool_references: List[_models.ScalingHostPoolReference] | None = None, **kwargs: Any)[source]

Bases: Model

Scaling plan properties that can be patched.

Variables:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of scaling plan.

  • friendly_name (str) – User friendly name of scaling plan.

  • time_zone (str) – Timezone of the scaling plan.

  • exclusion_tag (str) – Exclusion tag for scaling plan.

  • schedules (list[ScalingSchedule]) – List of ScalingSchedule definitions.

  • host_pool_references (list[ScalingHostPoolReference]) – List of ScalingHostPoolReference definitions.

Keyword Arguments:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of scaling plan.

  • friendly_name (str) – User friendly name of scaling plan.

  • time_zone (str) – Timezone of the scaling plan.

  • exclusion_tag (str) – Exclusion tag for scaling plan.

  • schedules (list[ScalingSchedule]) – List of ScalingSchedule definitions.

  • host_pool_references (list[ScalingHostPoolReference]) – List of ScalingHostPoolReference definitions.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPersonalSchedule(*, days_of_week: List[str | _models.DayOfWeek] | None = None, ramp_up_start_time: _models.Time | None = None, ramp_up_auto_start_hosts: str | _models.StartupBehavior | None = None, ramp_up_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, ramp_up_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, ramp_up_minutes_to_wait_on_disconnect: int | None = None, ramp_up_action_on_logoff: str | _models.SessionHandlingOperation | None = None, ramp_up_minutes_to_wait_on_logoff: int | None = None, peak_start_time: _models.Time | None = None, peak_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, peak_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, peak_minutes_to_wait_on_disconnect: int | None = None, peak_action_on_logoff: str | _models.SessionHandlingOperation | None = None, peak_minutes_to_wait_on_logoff: int | None = None, ramp_down_start_time: _models.Time | None = None, ramp_down_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, ramp_down_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, ramp_down_minutes_to_wait_on_disconnect: int | None = None, ramp_down_action_on_logoff: str | _models.SessionHandlingOperation | None = None, ramp_down_minutes_to_wait_on_logoff: int | None = None, off_peak_start_time: _models.Time | None = None, off_peak_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, off_peak_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, off_peak_minutes_to_wait_on_disconnect: int | None = None, off_peak_action_on_logoff: str | _models.SessionHandlingOperation | None = None, off_peak_minutes_to_wait_on_logoff: int | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Represents a ScalingPlanPersonalSchedule definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_auto_start_hosts (str or StartupBehavior) – The desired startup behavior during the ramp up period for personal vms in the hostpool. Known values are: “None”, “WithAssignedUser”, and “All”.

  • ramp_up_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. Known values are: “Enable” and “Disable”.

  • ramp_up_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.

  • ramp_up_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the peak phase. Known values are: “Enable” and “Disable”.

  • peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.

  • peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. Known values are: “Enable” and “Disable”.

  • ramp_down_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.

  • ramp_down_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. Known values are: “Enable” and “Disable”.

  • off_peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.

  • off_peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.

Keyword Arguments:

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_auto_start_hosts (str or StartupBehavior) – The desired startup behavior during the ramp up period for personal vms in the hostpool. Known values are: “None”, “WithAssignedUser”, and “All”.

  • ramp_up_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. Known values are: “Enable” and “Disable”.

  • ramp_up_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.

  • ramp_up_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the peak phase. Known values are: “Enable” and “Disable”.

  • peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.

  • peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. Known values are: “Enable” and “Disable”.

  • ramp_down_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.

  • ramp_down_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. Known values are: “Enable” and “Disable”.

  • off_peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.

  • off_peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPersonalScheduleList(*, value: List[_models.ScalingPlanPersonalSchedule] | None = None, **kwargs: Any)[source]

Bases: Model

List of ScalingPlanPersonalSchedule definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[ScalingPlanPersonalSchedule]) – List of ScalingPlanPersonalSchedule definitions.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPersonalSchedulePatch(*, days_of_week: List[str | _models.DayOfWeek] | None = None, ramp_up_start_time: _models.Time | None = None, ramp_up_auto_start_hosts: str | _models.StartupBehavior | None = None, ramp_up_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, ramp_up_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, ramp_up_minutes_to_wait_on_disconnect: int | None = None, ramp_up_action_on_logoff: str | _models.SessionHandlingOperation | None = None, ramp_up_minutes_to_wait_on_logoff: int | None = None, peak_start_time: _models.Time | None = None, peak_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, peak_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, peak_minutes_to_wait_on_disconnect: int | None = None, peak_action_on_logoff: str | _models.SessionHandlingOperation | None = None, peak_minutes_to_wait_on_logoff: int | None = None, ramp_down_start_time: _models.Time | None = None, ramp_down_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, ramp_down_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, ramp_down_minutes_to_wait_on_disconnect: int | None = None, ramp_down_action_on_logoff: str | _models.SessionHandlingOperation | None = None, ramp_down_minutes_to_wait_on_logoff: int | None = None, off_peak_start_time: _models.Time | None = None, off_peak_start_vm_on_connect: str | _models.SetStartVMOnConnect | None = None, off_peak_action_on_disconnect: str | _models.SessionHandlingOperation | None = None, off_peak_minutes_to_wait_on_disconnect: int | None = None, off_peak_action_on_logoff: str | _models.SessionHandlingOperation | None = None, off_peak_minutes_to_wait_on_logoff: int | None = None, **kwargs: Any)[source]

Bases: Model

ScalingPlanPersonalSchedule properties that can be patched.

Variables:

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_auto_start_hosts (str or StartupBehavior) – The desired startup behavior during the ramp up period for personal vms in the hostpool. Known values are: “None”, “WithAssignedUser”, and “All”.

  • ramp_up_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. Known values are: “Enable” and “Disable”.

  • ramp_up_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.

  • ramp_up_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the peak phase. Known values are: “Enable” and “Disable”.

  • peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.

  • peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. Known values are: “Enable” and “Disable”.

  • ramp_down_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.

  • ramp_down_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. Known values are: “Enable” and “Disable”.

  • off_peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.

  • off_peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.

Keyword Arguments:

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_auto_start_hosts (str or StartupBehavior) – The desired startup behavior during the ramp up period for personal vms in the hostpool. Known values are: “None”, “WithAssignedUser”, and “All”.

  • ramp_up_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. Known values are: “Enable” and “Disable”.

  • ramp_up_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.

  • ramp_up_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp up period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_up_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the peak phase. Known values are: “Enable” and “Disable”.

  • peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.

  • peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. Known values are: “Enable” and “Disable”.

  • ramp_down_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.

  • ramp_down_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the ramp down period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • ramp_down_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_start_vm_on_connect (str or SetStartVMOnConnect) – The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. Known values are: “Enable” and “Disable”.

  • off_peak_action_on_disconnect (str or SessionHandlingOperation) – Action to be taken after a user disconnect during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_disconnect (int) – The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.

  • off_peak_action_on_logoff (str or SessionHandlingOperation) – Action to be taken after a logoff during the off-peak period. Known values are: “None”, “Deallocate”, and “Hibernate”.

  • off_peak_minutes_to_wait_on_logoff (int) – The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPooledSchedule(*, days_of_week: List[str | _models.DayOfWeek] | None = None, ramp_up_start_time: _models.Time | None = None, ramp_up_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_up_minimum_hosts_pct: int | None = None, ramp_up_capacity_threshold_pct: int | None = None, peak_start_time: _models.Time | None = None, peak_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_down_start_time: _models.Time | None = None, ramp_down_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_down_minimum_hosts_pct: int | None = None, ramp_down_capacity_threshold_pct: int | None = None, ramp_down_force_logoff_users: bool | None = None, ramp_down_stop_hosts_when: str | _models.StopHostsWhen | None = None, ramp_down_wait_time_minutes: int | None = None, ramp_down_notification_message: str | None = None, off_peak_start_time: _models.Time | None = None, off_peak_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, **kwargs: Any)[source]

Bases: Resource

Represents a ScalingPlanPooledSchedule definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp up period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_up_minimum_hosts_pct (int) – Minimum host percentage for ramp up period.

  • ramp_up_capacity_threshold_pct (int) – Capacity threshold for ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for peak period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp down period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_minimum_hosts_pct (int) – Minimum host percentage for ramp down period.

  • ramp_down_capacity_threshold_pct (int) – Capacity threshold for ramp down period.

  • ramp_down_force_logoff_users (bool) – Should users be logged off forcefully from hosts.

  • ramp_down_stop_hosts_when (str or StopHostsWhen) – Specifies when to stop hosts during ramp down period. Known values are: “ZeroSessions” and “ZeroActiveSessions”.

  • ramp_down_wait_time_minutes (int) – Number of minutes to wait to stop hosts during ramp down period.

  • ramp_down_notification_message (str) – Notification message for users during ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for off-peak period. Known values are: “BreadthFirst” and “DepthFirst”.

Keyword Arguments:

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp up period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_up_minimum_hosts_pct (int) – Minimum host percentage for ramp up period.

  • ramp_up_capacity_threshold_pct (int) – Capacity threshold for ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for peak period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp down period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_minimum_hosts_pct (int) – Minimum host percentage for ramp down period.

  • ramp_down_capacity_threshold_pct (int) – Capacity threshold for ramp down period.

  • ramp_down_force_logoff_users (bool) – Should users be logged off forcefully from hosts.

  • ramp_down_stop_hosts_when (str or StopHostsWhen) – Specifies when to stop hosts during ramp down period. Known values are: “ZeroSessions” and “ZeroActiveSessions”.

  • ramp_down_wait_time_minutes (int) – Number of minutes to wait to stop hosts during ramp down period.

  • ramp_down_notification_message (str) – Notification message for users during ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for off-peak period. Known values are: “BreadthFirst” and “DepthFirst”.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPooledScheduleList(*, value: List[_models.ScalingPlanPooledSchedule] | None = None, **kwargs: Any)[source]

Bases: Model

List of ScalingPlanPooledSchedule definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[ScalingPlanPooledSchedule]) – List of ScalingPlanPooledSchedule definitions.

class azure.mgmt.desktopvirtualization.models.ScalingPlanPooledSchedulePatch(*, days_of_week: List[str | _models.DayOfWeek] | None = None, ramp_up_start_time: _models.Time | None = None, ramp_up_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_up_minimum_hosts_pct: int | None = None, ramp_up_capacity_threshold_pct: int | None = None, peak_start_time: _models.Time | None = None, peak_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_down_start_time: _models.Time | None = None, ramp_down_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_down_minimum_hosts_pct: int | None = None, ramp_down_capacity_threshold_pct: int | None = None, ramp_down_force_logoff_users: bool | None = None, ramp_down_stop_hosts_when: str | _models.StopHostsWhen | None = None, ramp_down_wait_time_minutes: int | None = None, ramp_down_notification_message: str | None = None, off_peak_start_time: _models.Time | None = None, off_peak_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, **kwargs: Any)[source]

Bases: Resource

ScalingPlanPooledSchedule properties that can be patched.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp up period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_up_minimum_hosts_pct (int) – Minimum host percentage for ramp up period.

  • ramp_up_capacity_threshold_pct (int) – Capacity threshold for ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for peak period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp down period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_minimum_hosts_pct (int) – Minimum host percentage for ramp down period.

  • ramp_down_capacity_threshold_pct (int) – Capacity threshold for ramp down period.

  • ramp_down_force_logoff_users (bool) – Should users be logged off forcefully from hosts.

  • ramp_down_stop_hosts_when (str or StopHostsWhen) – Specifies when to stop hosts during ramp down period. Known values are: “ZeroSessions” and “ZeroActiveSessions”.

  • ramp_down_wait_time_minutes (int) – Number of minutes to wait to stop hosts during ramp down period.

  • ramp_down_notification_message (str) – Notification message for users during ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for off-peak period. Known values are: “BreadthFirst” and “DepthFirst”.

Keyword Arguments:

  • days_of_week (list[str or DayOfWeek]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp up period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_up_minimum_hosts_pct (int) – Minimum host percentage for ramp up period.

  • ramp_up_capacity_threshold_pct (int) – Capacity threshold for ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for peak period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp down period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_minimum_hosts_pct (int) – Minimum host percentage for ramp down period.

  • ramp_down_capacity_threshold_pct (int) – Capacity threshold for ramp down period.

  • ramp_down_force_logoff_users (bool) – Should users be logged off forcefully from hosts.

  • ramp_down_stop_hosts_when (str or StopHostsWhen) – Specifies when to stop hosts during ramp down period. Known values are: “ZeroSessions” and “ZeroActiveSessions”.

  • ramp_down_wait_time_minutes (int) – Number of minutes to wait to stop hosts during ramp down period.

  • ramp_down_notification_message (str) – Notification message for users during ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for off-peak period. Known values are: “BreadthFirst” and “DepthFirst”.

class azure.mgmt.desktopvirtualization.models.ScalingSchedule(*, name: str | None = None, days_of_week: List[str | _models.ScalingScheduleDaysOfWeekItem] | None = None, ramp_up_start_time: _models.Time | None = None, ramp_up_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_up_minimum_hosts_pct: int | None = None, ramp_up_capacity_threshold_pct: int | None = None, peak_start_time: _models.Time | None = None, peak_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_down_start_time: _models.Time | None = None, ramp_down_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, ramp_down_minimum_hosts_pct: int | None = None, ramp_down_capacity_threshold_pct: int | None = None, ramp_down_force_logoff_users: bool | None = None, ramp_down_stop_hosts_when: str | _models.StopHostsWhen | None = None, ramp_down_wait_time_minutes: int | None = None, ramp_down_notification_message: str | None = None, off_peak_start_time: _models.Time | None = None, off_peak_load_balancing_algorithm: str | _models.SessionHostLoadBalancingAlgorithm | None = None, **kwargs: Any)[source]

Bases: Model

A ScalingPlanPooledSchedule.

Variables:

  • name (str) – Name of the ScalingPlanPooledSchedule.

  • days_of_week (list[str or ScalingScheduleDaysOfWeekItem]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp up period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_up_minimum_hosts_pct (int) – Minimum host percentage for ramp up period.

  • ramp_up_capacity_threshold_pct (int) – Capacity threshold for ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for peak period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp down period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_minimum_hosts_pct (int) – Minimum host percentage for ramp down period.

  • ramp_down_capacity_threshold_pct (int) – Capacity threshold for ramp down period.

  • ramp_down_force_logoff_users (bool) – Should users be logged off forcefully from hosts.

  • ramp_down_stop_hosts_when (str or StopHostsWhen) – Specifies when to stop hosts during ramp down period. Known values are: “ZeroSessions” and “ZeroActiveSessions”.

  • ramp_down_wait_time_minutes (int) – Number of minutes to wait to stop hosts during ramp down period.

  • ramp_down_notification_message (str) – Notification message for users during ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for off-peak period. Known values are: “BreadthFirst” and “DepthFirst”.

Keyword Arguments:

  • name (str) – Name of the ScalingPlanPooledSchedule.

  • days_of_week (list[str or ScalingScheduleDaysOfWeekItem]) – Set of days of the week on which this schedule is active.

  • ramp_up_start_time (Time) – Starting time for ramp up period.

  • ramp_up_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp up period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_up_minimum_hosts_pct (int) – Minimum host percentage for ramp up period.

  • ramp_up_capacity_threshold_pct (int) – Capacity threshold for ramp up period.

  • peak_start_time (Time) – Starting time for peak period.

  • peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for peak period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_start_time (Time) – Starting time for ramp down period.

  • ramp_down_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for ramp down period. Known values are: “BreadthFirst” and “DepthFirst”.

  • ramp_down_minimum_hosts_pct (int) – Minimum host percentage for ramp down period.

  • ramp_down_capacity_threshold_pct (int) – Capacity threshold for ramp down period.

  • ramp_down_force_logoff_users (bool) – Should users be logged off forcefully from hosts.

  • ramp_down_stop_hosts_when (str or StopHostsWhen) – Specifies when to stop hosts during ramp down period. Known values are: “ZeroSessions” and “ZeroActiveSessions”.

  • ramp_down_wait_time_minutes (int) – Number of minutes to wait to stop hosts during ramp down period.

  • ramp_down_notification_message (str) – Notification message for users during ramp down period.

  • off_peak_start_time (Time) – Starting time for off-peak period.

  • off_peak_load_balancing_algorithm (str or SessionHostLoadBalancingAlgorithm) – Load balancing algorithm for off-peak period. Known values are: “BreadthFirst” and “DepthFirst”.

class azure.mgmt.desktopvirtualization.models.ScalingScheduleDaysOfWeekItem(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

ScalingScheduleDaysOfWeekItem.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.desktopvirtualization.models.SendMessage(*, message_title: str | None = None, message_body: str | None = None, **kwargs: Any)[source]

Bases: Model

Represents message sent to a UserSession.

Variables:

  • message_title (str) – Title of message.

  • message_body (str) – Body of message.

Keyword Arguments:

  • message_title (str) – Title of message.

  • message_body (str) – Body of message.

class azure.mgmt.desktopvirtualization.models.ServiceSpecification(*, log_specifications: List[_models.LogSpecification] | None = None, **kwargs: Any)[source]

Bases: Model

Service specification payload.

Variables:

log_specifications (list[LogSpecification]) – Specifications of the Log for Azure Monitoring.

Keyword Arguments:

log_specifications (list[LogSpecification]) – Specifications of the Log for Azure Monitoring.

class azure.mgmt.desktopvirtualization.models.SessionHandlingOperation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Action to be taken after a user disconnect during the ramp up period.

DEALLOCATE = 'Deallocate'
HIBERNATE = 'Hibernate'
NONE = 'None'
class azure.mgmt.desktopvirtualization.models.SessionHost(*, last_heart_beat: datetime | None = None, sessions: int | None = None, agent_version: str | None = None, allow_new_session: bool | None = None, assigned_user: str | None = None, friendly_name: str | None = None, status: str | _models.Status | None = None, os_version: str | None = None, sx_s_stack_version: str | None = None, update_state: str | _models.UpdateState | None = None, update_error_message: str | None = None, **kwargs: Any)[source]

Bases: Resource

Represents a SessionHost definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • object_id (str) – ObjectId of SessionHost. (internal use).

  • last_heart_beat (datetime) – Last heart beat from SessionHost.

  • sessions (int) – Number of sessions on SessionHost.

  • agent_version (str) – Version of agent on SessionHost.

  • allow_new_session (bool) – Allow a new session.

  • virtual_machine_id (str) – Virtual Machine Id of SessionHost’s underlying virtual machine.

  • resource_id (str) – Resource Id of SessionHost’s underlying virtual machine.

  • assigned_user (str) – User assigned to SessionHost.

  • friendly_name (str) – Friendly name of SessionHost.

  • status (str or Status) – Status for a SessionHost. Known values are: “Available”, “Unavailable”, “Shutdown”, “Disconnected”, “Upgrading”, “UpgradeFailed”, “NoHeartbeat”, “NotJoinedToDomain”, “DomainTrustRelationshipLost”, “SxSStackListenerNotReady”, “FSLogixNotHealthy”, and “NeedsAssistance”.

  • status_timestamp (datetime) – The timestamp of the status.

  • os_version (str) – The version of the OS on the session host.

  • sx_s_stack_version (str) – The version of the side by side stack on the session host.

  • update_state (str or UpdateState) – Update state of a SessionHost. Known values are: “Initial”, “Pending”, “Started”, “Succeeded”, and “Failed”.

  • last_update_time (datetime) – The timestamp of the last update.

  • update_error_message (str) – The error message.

  • session_host_health_check_results (list[SessionHostHealthCheckReport]) – List of SessionHostHealthCheckReports.

Keyword Arguments:

  • last_heart_beat (datetime) – Last heart beat from SessionHost.

  • sessions (int) – Number of sessions on SessionHost.

  • agent_version (str) – Version of agent on SessionHost.

  • allow_new_session (bool) – Allow a new session.

  • assigned_user (str) – User assigned to SessionHost.

  • friendly_name (str) – Friendly name of SessionHost.

  • status (str or Status) – Status for a SessionHost. Known values are: “Available”, “Unavailable”, “Shutdown”, “Disconnected”, “Upgrading”, “UpgradeFailed”, “NoHeartbeat”, “NotJoinedToDomain”, “DomainTrustRelationshipLost”, “SxSStackListenerNotReady”, “FSLogixNotHealthy”, and “NeedsAssistance”.

  • os_version (str) – The version of the OS on the session host.

  • sx_s_stack_version (str) – The version of the side by side stack on the session host.

  • update_state (str or UpdateState) – Update state of a SessionHost. Known values are: “Initial”, “Pending”, “Started”, “Succeeded”, and “Failed”.

  • update_error_message (str) – The error message.

class azure.mgmt.desktopvirtualization.models.SessionHostComponentUpdateType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of maintenance for session host components.

DEFAULT = 'Default'

Agent and other agent side components are delivery schedule is controlled by WVD Infra.

SCHEDULED = 'Scheduled'

TenantAdmin have opted in for Scheduled Component Update feature.

class azure.mgmt.desktopvirtualization.models.SessionHostHealthCheckFailureDetails(**kwargs: Any)[source]

Bases: Model

Contains details on the failure.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • message (str) – Failure message: hints on what is wrong and how to recover.

  • error_code (int) – Error code corresponding for the failure.

  • last_health_check_date_time (datetime) – The timestamp of the last update.

class azure.mgmt.desktopvirtualization.models.SessionHostHealthCheckReport(**kwargs: Any)[source]

Bases: Model

The report for session host information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • health_check_name (str or HealthCheckName) – Represents the name of the health check operation performed. Known values are: “DomainJoinedCheck”, “DomainTrustCheck”, “FSLogixHealthCheck”, “SxSStackListenerCheck”, “UrlsAccessibleCheck”, “MonitoringAgentCheck”, “DomainReachable”, “WebRTCRedirectorCheck”, “SupportedEncryptionCheck”, “MetaDataServiceCheck”, and “AppAttachHealthCheck”.

  • health_check_result (str or HealthCheckResult) – Represents the Health state of the health check we performed. Known values are: “Unknown”, “HealthCheckSucceeded”, “HealthCheckFailed”, and “SessionHostShutdown”.

  • additional_failure_details (SessionHostHealthCheckFailureDetails) – Additional detailed information on the failure.

class azure.mgmt.desktopvirtualization.models.SessionHostList(*, value: List[_models.SessionHost] | None = None, **kwargs: Any)[source]

Bases: Model

List of SessionHost definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[SessionHost]) – List of SessionHost definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[SessionHost]) – List of SessionHost definitions.

class azure.mgmt.desktopvirtualization.models.SessionHostLoadBalancingAlgorithm(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Load balancing algorithm for ramp up period.

BREADTH_FIRST = 'BreadthFirst'
DEPTH_FIRST = 'DepthFirst'
class azure.mgmt.desktopvirtualization.models.SessionHostPatch(*, allow_new_session: bool | None = None, assigned_user: str | None = None, friendly_name: str | None = None, **kwargs: Any)[source]

Bases: Resource

SessionHost properties that can be patched.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • allow_new_session (bool) – Allow a new session.

  • assigned_user (str) – User assigned to SessionHost.

  • friendly_name (str) – Friendly name of SessionHost.

Keyword Arguments:

  • allow_new_session (bool) – Allow a new session.

  • assigned_user (str) – User assigned to SessionHost.

  • friendly_name (str) – Friendly name of SessionHost.

class azure.mgmt.desktopvirtualization.models.SessionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

State of user session.

ACTIVE = 'Active'
DISCONNECTED = 'Disconnected'
LOG_OFF = 'LogOff'
PENDING = 'Pending'
UNKNOWN = 'Unknown'
USER_PROFILE_DISK_MOUNTED = 'UserProfileDiskMounted'
class azure.mgmt.desktopvirtualization.models.SetStartVMOnConnect(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.

DISABLE = 'Disable'
ENABLE = 'Enable'
class azure.mgmt.desktopvirtualization.models.Sku(*, name: str, tier: str | _models.SkuTier | None = None, size: str | None = None, family: str | None = None, capacity: int | None = None, **kwargs: Any)[source]

Bases: Model

The resource model definition representing SKU.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The name of the SKU. E.g. P3. It is typically a letter+number code. Required.

  • tier (str or SkuTier) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Known values are: “Free”, “Basic”, “Standard”, and “Premium”.

  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

  • capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Keyword Arguments:

  • name (str) – The name of the SKU. E.g. P3. It is typically a letter+number code. Required.

  • tier (str or SkuTier) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Known values are: “Free”, “Basic”, “Standard”, and “Premium”.

  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

  • capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

class azure.mgmt.desktopvirtualization.models.SkuTier(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

BASIC = 'Basic'
FREE = 'Free'
PREMIUM = 'Premium'
STANDARD = 'Standard'
class azure.mgmt.desktopvirtualization.models.StartMenuItem(*, app_alias: str | None = None, file_path: str | None = None, command_line_arguments: str | None = None, icon_path: str | None = None, icon_index: int | None = None, **kwargs: Any)[source]

Bases: Resource

Represents a StartMenuItem definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • app_alias (str) – Alias of StartMenuItem.

  • file_path (str) – Path to the file of StartMenuItem.

  • command_line_arguments (str) – Command line arguments for StartMenuItem.

  • icon_path (str) – Path to the icon.

  • icon_index (int) – Index of the icon.

Keyword Arguments:

  • app_alias (str) – Alias of StartMenuItem.

  • file_path (str) – Path to the file of StartMenuItem.

  • command_line_arguments (str) – Command line arguments for StartMenuItem.

  • icon_path (str) – Path to the icon.

  • icon_index (int) – Index of the icon.

class azure.mgmt.desktopvirtualization.models.StartMenuItemList(*, value: List[_models.StartMenuItem] | None = None, **kwargs: Any)[source]

Bases: Model

List of StartMenuItem definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[StartMenuItem]) – List of StartMenuItem definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[StartMenuItem]) – List of StartMenuItem definitions.

class azure.mgmt.desktopvirtualization.models.StartupBehavior(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The desired startup behavior during the ramp up period for personal vms in the hostpool.

ALL = 'All'

All personal session hosts in the hostpool will be started during ramp up.

NONE = 'None'

Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts.

WITH_ASSIGNED_USER = 'WithAssignedUser'

Session hosts with an assigned user will be started during Ramp Up

class azure.mgmt.desktopvirtualization.models.Status(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Status for a SessionHost.

AVAILABLE = 'Available'

Session Host has passed all the health checks and is available to handle connections.

DISCONNECTED = 'Disconnected'

The Session Host is unavailable because it is currently disconnected.

DOMAIN_TRUST_RELATIONSHIP_LOST = 'DomainTrustRelationshipLost'

SessionHost’s domain trust relationship lost

FS_LOGIX_NOT_HEALTHY = 'FSLogixNotHealthy'

FSLogix is in an unhealthy state on the session host.

NEEDS_ASSISTANCE = 'NeedsAssistance'

New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal.

NOT_JOINED_TO_DOMAIN = 'NotJoinedToDomain'

SessionHost is not joined to domain.

NO_HEARTBEAT = 'NoHeartbeat'

The Session Host is not heart beating.

SHUTDOWN = 'Shutdown'

Session Host is shutdown - RD Agent reported session host to be stopped or deallocated.

SX_S_STACK_LISTENER_NOT_READY = 'SxSStackListenerNotReady'

SxS stack installed on the SessionHost is not ready to receive connections.

UNAVAILABLE = 'Unavailable'

Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous ‘NoHeartBeat’ status.

UPGRADE_FAILED = 'UpgradeFailed'

Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed.

UPGRADING = 'Upgrading'

Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections.

class azure.mgmt.desktopvirtualization.models.StopHostsWhen(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Specifies when to stop hosts during ramp down period.

ZERO_ACTIVE_SESSIONS = 'ZeroActiveSessions'
ZERO_SESSIONS = 'ZeroSessions'
class azure.mgmt.desktopvirtualization.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.desktopvirtualization.models.Time(*, hour: int, minute: int, **kwargs: Any)[source]

Bases: Model

The time for a scaling action to occur.

All required parameters must be populated in order to send to server.

Variables:

  • hour (int) – The hour. Required.

  • minute (int) – The minute. Required.

Keyword Arguments:

  • hour (int) – The hour. Required.

  • minute (int) – The minute. Required.

class azure.mgmt.desktopvirtualization.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.desktopvirtualization.models.UpdateState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Update state of a SessionHost.

FAILED = 'Failed'
INITIAL = 'Initial'
PENDING = 'Pending'
STARTED = 'Started'
SUCCEEDED = 'Succeeded'
class azure.mgmt.desktopvirtualization.models.UserSession(*, user_principal_name: str | None = None, application_type: str | _models.ApplicationType | None = None, session_state: str | _models.SessionState | None = None, active_directory_user_name: str | None = None, create_time: datetime | None = None, **kwargs: Any)[source]

Bases: Resource

Represents a UserSession definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • object_id (str) – ObjectId of user session. (internal use).

  • user_principal_name (str) – The user principal name.

  • application_type (str or ApplicationType) – Application type of application. Known values are: “RemoteApp” and “Desktop”.

  • session_state (str or SessionState) – State of user session. Known values are: “Unknown”, “Active”, “Disconnected”, “Pending”, “LogOff”, and “UserProfileDiskMounted”.

  • active_directory_user_name (str) – The active directory user name.

  • create_time (datetime) – The timestamp of the user session create.

Keyword Arguments:

  • user_principal_name (str) – The user principal name.

  • application_type (str or ApplicationType) – Application type of application. Known values are: “RemoteApp” and “Desktop”.

  • session_state (str or SessionState) – State of user session. Known values are: “Unknown”, “Active”, “Disconnected”, “Pending”, “LogOff”, and “UserProfileDiskMounted”.

  • active_directory_user_name (str) – The active directory user name.

  • create_time (datetime) – The timestamp of the user session create.

class azure.mgmt.desktopvirtualization.models.UserSessionList(*, value: List[_models.UserSession] | None = None, **kwargs: Any)[source]

Bases: Model

List of UserSession definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[UserSession]) – List of UserSession definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[UserSession]) – List of UserSession definitions.

class azure.mgmt.desktopvirtualization.models.Workspace(*, location: str, tags: Dict[str, str] | None = None, managed_by: str | None = None, kind: str | None = None, identity: _models.ResourceModelWithAllowedPropertySetIdentity | None = None, sku: _models.ResourceModelWithAllowedPropertySetSku | None = None, plan: _models.ResourceModelWithAllowedPropertySetPlan | None = None, description: str | None = None, friendly_name: str | None = None, application_group_references: List[str] | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, **kwargs: Any)[source]

Bases: ResourceModelWithAllowedPropertySet

Represents a Workspace definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • etag (str) – The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • object_id (str) – ObjectId of Workspace. (internal use).

  • description (str) – Description of Workspace.

  • friendly_name (str) – Friendly name of Workspace.

  • application_group_references (list[str]) – List of applicationGroup resource Ids.

  • cloud_pc_resource (bool) – Is cloud pc resource.

  • public_network_access (str or PublicNetworkAccess) – Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: “Enabled” and “Disabled”.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connection associated with the specified resource.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • kind (str) – Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • identity (ResourceModelWithAllowedPropertySetIdentity)

  • sku (ResourceModelWithAllowedPropertySetSku)

  • plan (ResourceModelWithAllowedPropertySetPlan)

  • description (str) – Description of Workspace.

  • friendly_name (str) – Friendly name of Workspace.

  • application_group_references (list[str]) – List of applicationGroup resource Ids.

  • public_network_access (str or PublicNetworkAccess) – Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.desktopvirtualization.models.WorkspaceList(*, value: List[_models.Workspace] | None = None, **kwargs: Any)[source]

Bases: Model

List of Workspace definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[Workspace]) – List of Workspace definitions.

  • next_link (str) – Link to the next page of results.

Keyword Arguments:

value (list[Workspace]) – List of Workspace definitions.

class azure.mgmt.desktopvirtualization.models.WorkspacePatch(*, tags: Dict[str, str] | None = None, description: str | None = None, friendly_name: str | None = None, application_group_references: List[str] | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, **kwargs: Any)[source]

Bases: Model

Workspace properties that can be patched.

Variables:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of Workspace.

  • friendly_name (str) – Friendly name of Workspace.

  • application_group_references (list[str]) – List of applicationGroup links.

  • public_network_access (str or PublicNetworkAccess) – Enabled to allow this resource to be access from the public network. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

  • tags (dict[str, str]) – tags to be updated.

  • description (str) – Description of Workspace.

  • friendly_name (str) – Friendly name of Workspace.

  • application_group_references (list[str]) – List of applicationGroup links.

  • public_network_access (str or PublicNetworkAccess) – Enabled to allow this resource to be access from the public network. Known values are: “Enabled” and “Disabled”.