azure-mgmt-devtestlabs 10.0.0b2
Microsoft Azure Dev Test Labs Management Client Library for Python
License: MIT License
Requires Python: >=3.8
Keywords: azure, azure sdk

# Microsoft Azure SDK for Python

This is the Microsoft Azure Dev Test Labs Management Client Library.
This package has been tested with Python 3.8+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

## Getting started

### Prerequisites

- Python 3.8+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-devtestlabs
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = DevTestLabsClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search Dev Test Labs Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 


# Release History

## 10.0.0b2 (2024-11-04)

### Other Changes

  - Update dependencies

## 10.0.0b1 (2022-10-28)

### Features Added

  - Model Disk has a new parameter storage_account_id

### Breaking Changes

  - Model ApplicableScheduleFragment no longer has parameter lab_vms_shutdown
  - Model ApplicableScheduleFragment no longer has parameter lab_vms_startup
  - Model ArtifactSourceFragment no longer has parameter arm_template_folder_path
  - Model ArtifactSourceFragment no longer has parameter branch_ref
  - Model ArtifactSourceFragment no longer has parameter display_name
  - Model ArtifactSourceFragment no longer has parameter folder_path
  - Model ArtifactSourceFragment no longer has parameter security_token
  - Model ArtifactSourceFragment no longer has parameter source_type
  - Model ArtifactSourceFragment no longer has parameter status
  - Model ArtifactSourceFragment no longer has parameter uri
  - Model CustomImageFragment no longer has parameter author
  - Model CustomImageFragment no longer has parameter custom_image_plan
  - Model CustomImageFragment no longer has parameter data_disk_storage_info
  - Model CustomImageFragment no longer has parameter description
  - Model CustomImageFragment no longer has parameter is_plan_authorized
  - Model CustomImageFragment no longer has parameter managed_image_id
  - Model CustomImageFragment no longer has parameter managed_snapshot_id
  - Model CustomImageFragment no longer has parameter vhd
  - Model CustomImageFragment no longer has parameter vm
  - Model DiskFragment no longer has parameter disk_blob_name
  - Model DiskFragment no longer has parameter disk_size_gi_b
  - Model DiskFragment no longer has parameter disk_type
  - Model DiskFragment no longer has parameter disk_uri
  - Model DiskFragment no longer has parameter host_caching
  - Model DiskFragment no longer has parameter leased_by_lab_vm_id
  - Model DiskFragment no longer has parameter managed_disk_id
  - Model DtlEnvironmentFragment no longer has parameter arm_template_display_name
  - Model DtlEnvironmentFragment no longer has parameter deployment_properties
  - Model FormulaFragment no longer has parameter author
  - Model FormulaFragment no longer has parameter description
  - Model FormulaFragment no longer has parameter formula_content
  - Model FormulaFragment no longer has parameter os_type
  - Model FormulaFragment no longer has parameter vm
  - Model LabFragment no longer has parameter announcement
  - Model LabFragment no longer has parameter environment_permission
  - Model LabFragment no longer has parameter extended_properties
  - Model LabFragment no longer has parameter lab_storage_type
  - Model LabFragment no longer has parameter mandatory_artifacts_resource_ids_linux
  - Model LabFragment no longer has parameter mandatory_artifacts_resource_ids_windows
  - Model LabFragment no longer has parameter premium_data_disks
  - Model LabFragment no longer has parameter support
  - Model LabVirtualMachineCreationParameter no longer has parameter artifact_deployment_status
  - Model LabVirtualMachineCreationParameter no longer has parameter compute_id
  - Model LabVirtualMachineCreationParameter no longer has parameter created_by_user
  - Model LabVirtualMachineCreationParameter no longer has parameter created_by_user_id
  - Model LabVirtualMachineCreationParameter no longer has parameter fqdn
  - Model LabVirtualMachineCreationParameter no longer has parameter last_known_power_state
  - Model LabVirtualMachineCreationParameter no longer has parameter os_type
  - Model LabVirtualMachineCreationParameter no longer has parameter virtual_machine_creation_source
  - Model LabVirtualMachineFragment no longer has parameter allow_claim
  - Model LabVirtualMachineFragment no longer has parameter artifact_deployment_status
  - Model LabVirtualMachineFragment no longer has parameter artifacts
  - Model LabVirtualMachineFragment no longer has parameter compute_id
  - Model LabVirtualMachineFragment no longer has parameter created_by_user
  - Model LabVirtualMachineFragment no longer has parameter created_by_user_id
  - Model LabVirtualMachineFragment no longer has parameter created_date
  - Model LabVirtualMachineFragment no longer has parameter custom_image_id
  - Model LabVirtualMachineFragment no longer has parameter data_disk_parameters
  - Model LabVirtualMachineFragment no longer has parameter disallow_public_ip_address
  - Model LabVirtualMachineFragment no longer has parameter environment_id
  - Model LabVirtualMachineFragment no longer has parameter expiration_date
  - Model LabVirtualMachineFragment no longer has parameter fqdn
  - Model LabVirtualMachineFragment no longer has parameter gallery_image_reference
  - Model LabVirtualMachineFragment no longer has parameter is_authentication_with_ssh_key
  - Model LabVirtualMachineFragment no longer has parameter lab_subnet_name
  - Model LabVirtualMachineFragment no longer has parameter lab_virtual_network_id
  - Model LabVirtualMachineFragment no longer has parameter last_known_power_state
  - Model LabVirtualMachineFragment no longer has parameter network_interface
  - Model LabVirtualMachineFragment no longer has parameter notes
  - Model LabVirtualMachineFragment no longer has parameter os_type
  - Model LabVirtualMachineFragment no longer has parameter owner_object_id
  - Model LabVirtualMachineFragment no longer has parameter owner_user_principal_name
  - Model LabVirtualMachineFragment no longer has parameter password
  - Model LabVirtualMachineFragment no longer has parameter plan_id
  - Model LabVirtualMachineFragment no longer has parameter schedule_parameters
  - Model LabVirtualMachineFragment no longer has parameter size
  - Model LabVirtualMachineFragment no longer has parameter ssh_key
  - Model LabVirtualMachineFragment no longer has parameter storage_type
  - Model LabVirtualMachineFragment no longer has parameter user_name
  - Model LabVirtualMachineFragment no longer has parameter virtual_machine_creation_source
  - Model NotificationChannelFragment no longer has parameter description
  - Model NotificationChannelFragment no longer has parameter email_recipient
  - Model NotificationChannelFragment no longer has parameter events
  - Model NotificationChannelFragment no longer has parameter notification_locale
  - Model NotificationChannelFragment no longer has parameter web_hook_url
  - Model PolicyFragment no longer has parameter description
  - Model PolicyFragment no longer has parameter evaluator_type
  - Model PolicyFragment no longer has parameter fact_data
  - Model PolicyFragment no longer has parameter fact_name
  - Model PolicyFragment no longer has parameter status
  - Model PolicyFragment no longer has parameter threshold
  - Model ScheduleFragment no longer has parameter daily_recurrence
  - Model ScheduleFragment no longer has parameter hourly_recurrence
  - Model ScheduleFragment no longer has parameter notification_settings
  - Model ScheduleFragment no longer has parameter status
  - Model ScheduleFragment no longer has parameter target_resource_id
  - Model ScheduleFragment no longer has parameter task_type
  - Model ScheduleFragment no longer has parameter time_zone_id
  - Model ScheduleFragment no longer has parameter weekly_recurrence
  - Model SecretFragment no longer has parameter value
  - Model ServiceFabricFragment no longer has parameter environment_id
  - Model ServiceFabricFragment no longer has parameter external_service_fabric_id
  - Model UserFragment no longer has parameter identity
  - Model UserFragment no longer has parameter secret_store
  - Model VirtualNetworkFragment no longer has parameter allowed_subnets
  - Model VirtualNetworkFragment no longer has parameter description
  - Model VirtualNetworkFragment no longer has parameter external_provider_resource_id
  - Model VirtualNetworkFragment no longer has parameter subnet_overrides
  - Operation ArtifactSourcesOperations.update has a new parameter tags
  - Operation ArtifactSourcesOperations.update no longer has parameter artifact_source
  - Operation CustomImagesOperations.update has a new parameter tags
  - Operation CustomImagesOperations.update no longer has parameter custom_image
  - Operation DisksOperations.update has a new parameter tags
  - Operation DisksOperations.update no longer has parameter disk
  - Operation EnvironmentsOperations.update has a new parameter tags
  - Operation EnvironmentsOperations.update no longer has parameter dtl_environment
  - Operation FormulasOperations.update has a new parameter tags
  - Operation FormulasOperations.update no longer has parameter formula
  - Operation GlobalSchedulesOperations.update has a new parameter tags
  - Operation GlobalSchedulesOperations.update no longer has parameter schedule
  - Operation LabsOperations.update has a new parameter tags
  - Operation LabsOperations.update no longer has parameter lab
  - Operation NotificationChannelsOperations.update has a new parameter tags
  - Operation NotificationChannelsOperations.update no longer has parameter notification_channel
  - Operation PoliciesOperations.update has a new parameter tags
  - Operation PoliciesOperations.update no longer has parameter policy
  - Operation SchedulesOperations.update has a new parameter tags
  - Operation SchedulesOperations.update no longer has parameter schedule
  - Operation SecretsOperations.update no longer has parameter value
  - Operation ServiceFabricSchedulesOperations.update has a new parameter tags
  - Operation ServiceFabricSchedulesOperations.update no longer has parameter schedule
  - Operation ServiceFabricsOperations.update has a new parameter tags
  - Operation ServiceFabricsOperations.update no longer has parameter service_fabric
  - Operation UsersOperations.update has a new parameter tags
  - Operation UsersOperations.update no longer has parameter user
  - Operation VirtualMachineSchedulesOperations.update has a new parameter tags
  - Operation VirtualMachineSchedulesOperations.update no longer has parameter schedule
  - Operation VirtualMachinesOperations.update has a new parameter tags
  - Operation VirtualMachinesOperations.update no longer has parameter lab_virtual_machine
  - Operation VirtualNetworksOperations.update has a new parameter tags
  - Operation VirtualNetworksOperations.update no longer has parameter virtual_network

## 9.0.0 (2020-12-21)

- GA release

## 9.0.0b1 (2020-10-27)

This is beta preview version.
For detailed changelog please refer to equivalent stable version 4.0.0(https://pypi.org/project/azure-mgmt-devtestlabs/4.0.0/)

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

**General breaking changes**

- Credential system has been completly revamped:

  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
  - `credentials` parameter has been renamed `credential`

- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:

  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
  - For a complete set of supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

**General new features**

- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.

## 4.0.0 (2019-07-26)

**Breaking changes**

  - Removed operation ServiceRunnersOperations.list

**General breaking changes**

This version uses a next-generation code generator that *might*
introduce breaking changes if from some import. In summary, some modules
were incorrectly visible/importable and have been renamed. This fixed
several issues caused by usage of classes that were not supposed to be
used in the first place.

  - DevTestLabsClient cannot be imported from
    `azure.mgmt.devtestlabs.dev_test_labs_management_client`
    anymore (import from `azure.mgmt.devtestlabs` works like before)
  - DevTestLabsManagementClientConfiguration import has been moved from
    `azure.mgmt.devtestlabs.dev_test_labs_management_client` to
    `azure.mgmt.devtestlabs`
  - A model `MyClass` from a "models" sub-module cannot be imported
    anymore using `azure.mgmt.devtestlabs.models.my_class` (import
    from `azure.mgmt.devtestlabs.models` works like before)
  - An operation class `MyClassOperations` from an `operations`
    sub-module cannot be imported anymore using
    `azure.mgmt.devtestlabs.operations.my_class_operations` (import
    from `azure.mgmt.devtestlabs.operations` works like before)

Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.

## 3.0.0 (2019-02-07)

**Features**

  - Model NotificationChannel has a new parameter email_recipient
  - Model NotificationChannel has a new parameter notification_locale
  - Model ArtifactInstallProperties has a new parameter artifact_title
  - Model GalleryImage has a new parameter plan_id
  - Model GalleryImage has a new parameter is_plan_authorized
  - Model EvaluatePoliciesProperties has a new parameter
    user_object_id
  - Model ArtifactInstallPropertiesFragment has a new parameter
    artifact_title
  - Model Lab has a new parameter announcement
  - Model Lab has a new parameter support
  - Model Lab has a new parameter load_balancer_id
  - Model Lab has a new parameter
    mandatory_artifacts_resource_ids_linux
  - Model Lab has a new parameter extended_properties
  - Model Lab has a new parameter
    mandatory_artifacts_resource_ids_windows
  - Model Lab has a new parameter vm_creation_resource_group
  - Model Lab has a new parameter environment_permission
  - Model Lab has a new parameter network_security_group_id
  - Model Lab has a new parameter public_ip_id
  - Model NotificationSettingsFragment has a new parameter
    email_recipient
  - Model NotificationSettingsFragment has a new parameter
    notification_locale
  - Model LabVirtualMachineCreationParameter has a new parameter
    schedule_parameters
  - Model LabVirtualMachineCreationParameter has a new parameter
    compute_id
  - Model LabVirtualMachineCreationParameter has a new parameter
    data_disk_parameters
  - Model LabVirtualMachineCreationParameter has a new parameter
    last_known_power_state
  - Model LabVirtualMachineCreationParameter has a new parameter
    plan_id
  - Model ShutdownNotificationContent has a new parameter vm_url
  - Model ShutdownNotificationContent has a new parameter
    minutes_until_shutdown
  - Model NotificationSettings has a new parameter email_recipient
  - Model NotificationSettings has a new parameter notification_locale
  - Model LabVirtualMachine has a new parameter plan_id
  - Model LabVirtualMachine has a new parameter schedule_parameters
  - Model LabVirtualMachine has a new parameter
    last_known_power_state
  - Model LabVirtualMachine has a new parameter data_disk_parameters
  - Model ArmTemplate has a new parameter enabled
  - Model CustomImage has a new parameter custom_image_plan
  - Model CustomImage has a new parameter data_disk_storage_info
  - Model CustomImage has a new parameter is_plan_authorized
  - Model CustomImage has a new parameter managed_snapshot_id
  - Model LabVirtualMachineFragment has a new parameter
    schedule_parameters
  - Model LabVirtualMachineFragment has a new parameter compute_id
  - Model LabVirtualMachineFragment has a new parameter
    data_disk_parameters
  - Model LabVirtualMachineFragment has a new parameter
    last_known_power_state
  - Model LabVirtualMachineFragment has a new parameter plan_id
  - Added operation DisksOperations.update
  - Added operation CustomImagesOperations.update
  - Added operation LabsOperations.import_virtual_machine
  - Added operation SecretsOperations.update
  - Added operation EnvironmentsOperations.update
  - Added operation FormulasOperations.update
  - Added operation VirtualMachinesOperations.transfer_disks
  - Added operation VirtualMachinesOperations.un_claim
  - Added operation VirtualMachinesOperations.resize
  - Added operation VirtualMachinesOperations.restart
  - Added operation VirtualMachinesOperations.get_rdp_file_contents
  - Added operation VirtualMachinesOperations.redeploy
  - Added operation group ServiceFabricsOperations
  - Added operation group ServiceFabricSchedulesOperations

**Breaking changes**

  - Model VirtualNetworkFragment no longer has parameter type
  - Model VirtualNetworkFragment no longer has parameter id
  - Model VirtualNetworkFragment no longer has parameter location
  - Model VirtualNetworkFragment no longer has parameter name
  - Model VirtualNetworkFragment no longer has parameter
    external_subnets
  - Model VirtualNetworkFragment no longer has parameter
    provisioning_state
  - Model VirtualNetworkFragment no longer has parameter
    unique_identifier
  - Model PolicyFragment no longer has parameter type
  - Model PolicyFragment no longer has parameter id
  - Model PolicyFragment no longer has parameter location
  - Model PolicyFragment no longer has parameter name
  - Model PolicyFragment no longer has parameter unique_identifier
  - Model PolicyFragment no longer has parameter provisioning_state
  - Model ArtifactSourceFragment no longer has parameter type
  - Model ArtifactSourceFragment no longer has parameter id
  - Model ArtifactSourceFragment no longer has parameter location
  - Model ArtifactSourceFragment no longer has parameter name
  - Model ArtifactSourceFragment no longer has parameter
    unique_identifier
  - Model ArtifactSourceFragment no longer has parameter
    provisioning_state
  - Model LabVirtualMachineCreationParameter no longer has parameter
    applicable_schedule
  - Model LabVirtualMachineCreationParameter no longer has parameter
    compute_vm
  - Model LabVirtualMachineCreationParameter no longer has parameter
    unique_identifier
  - Model LabVirtualMachineCreationParameter no longer has parameter
    provisioning_state
  - Model ApplicableScheduleFragment no longer has parameter location
  - Model ApplicableScheduleFragment no longer has parameter type
  - Model ApplicableScheduleFragment no longer has parameter id
  - Model ApplicableScheduleFragment no longer has parameter name
  - Model ScheduleFragment no longer has parameter type
  - Model ScheduleFragment no longer has parameter id
  - Model ScheduleFragment no longer has parameter location
  - Model ScheduleFragment no longer has parameter name
  - Model ScheduleFragment no longer has parameter unique_identifier
  - Model ScheduleFragment no longer has parameter provisioning_state
  - Model LabVirtualMachineFragment no longer has parameter type
  - Model LabVirtualMachineFragment no longer has parameter id
  - Model LabVirtualMachineFragment no longer has parameter compute_vm
  - Model LabVirtualMachineFragment no longer has parameter location
  - Model LabVirtualMachineFragment no longer has parameter name
  - Model LabVirtualMachineFragment no longer has parameter
    unique_identifier
  - Model LabVirtualMachineFragment no longer has parameter
    provisioning_state
  - Model LabVirtualMachineFragment no longer has parameter
    applicable_schedule
  - Model LabFragment has a new signature
  - Model UserFragment has a new signature
  - Model NotificationChannelFragment has a new signature

## 2.2.0 (2018-02-15)

  - Add "providers" operation group

## 2.1.0 (2017-10-25)

  - Add "operations" operation group

## 2.0.0 (2017-04-27)

  - Major refactoring to follow name conventions + new features.
  - This wheel package is now built with the azure wheel extension

## 1.0.0 (2016-09-13)

  - Initial Release