azure-ai-ml 1.31.0
Microsoft Azure Machine Learning Client Library for Python
License: MIT License
Requires Python: >=3.7
Keywords: azure, azure sdk

# Azure ML Package client library for Python

We are excited to introduce the GA of Azure Machine Learning Python SDK v2. The Python SDK v2 introduces new SDK capabilities like standalone local jobs, reusable components for pipelines and managed online/batch inferencing. Python SDK v2 allows you to move from simple to complex tasks easily and incrementally. This is enabled by using a common object model which brings concept reuse and consistency of actions across various tasks. The SDK v2 shares its foundation with the CLI v2 which is also GA.

[Source code][source_code]
| [Package (PyPI)][ml_pypi]
| [Package (Conda)][ml_conda]
| [API reference documentation][ml_ref_docs]
| [Product documentation][product_documentation]
| [Samples][ml_samples]


This package has been tested with Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13 and 3.14.

For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all

## Getting started

### Prerequisites

- Python 3.7 or later is required to use this package.
- You must have an [Azure subscription][azure_subscription].
- An [Azure Machine Learning Workspace][workspace].

### Install the package

Install the Azure ML client library for Python with [pip][pip_link]:

```bash
pip install azure-ai-ml
pip install azure-identity
```

### Authenticate the client

```python
from azure.ai.ml import MLClient
from azure.identity import DefaultAzureCredential

ml_client = MLClient(
    DefaultAzureCredential(), subscription_id, resource_group, workspace
)
```

## Key concepts

Refer the below high level sequence diagram illustrating the package's workflow:

![azure-ai-ml sequence diagram](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ml/azure-ai-ml/azure_ai_ml_seq_diagram.png?raw=true)

## SDK Architecture Components

The sequence diagram above illustrates the architecture and workflow of the Azure ML Python SDK v2. Here's an explanation of the key components:

- **User**: You, the developer using the SDK to interact with Azure ML.
- **Entity**: Python classes representing Azure ML resources like Jobs, Models, Components, etc.
- **Schema**: Validation classes that ensure entities conform to expected structures and requirements.
- **MLClient**: The main entry point for all operations, providing access to various services.
- **Operations**: Specialized classes handling specific resource types (jobs, models, endpoints, etc.).
- **Telemetry**: Internal component for monitoring and collecting usage data (opt-out available).
- **Serialization**: Converts between Python objects and REST API formats.
- **REST Client**: Manages HTTP communications with Azure ML services.
- **Authentication**: Handles identity and access tokens via Azure Identity libraries.
- **AzureML Service**: The backend Azure Machine Learning service.

## Workflow Description

The diagram depicts two main workflows:

1. **Entity Creation and Validation**:
   - Create entities directly using Python classes or load from YAML files
   - YAML files are validated against schemas to ensure correctness
   - Validation errors are reported immediately if found

2. **Operation Execution**:
   - Initialize MLClient with proper credentials
   - Request operations through the client (create, get, list, delete, etc.)
   - Operations are routed to specialized classes for handling
   - Entities are serialized into REST API format
   - Authenticated HTTP requests are sent to Azure ML services
   - Responses are deserialized back into entity objects
   - Results are returned to the user

Azure Machine Learning Python SDK v2 comes with many new features like standalone local jobs, reusable components for pipelines and managed online/batch inferencing. The SDK v2 brings consistency and ease of use across all assets of the platform. The Python SDK v2 offers the following capabilities:
* Run **Standalone Jobs** - run a discrete ML activity as Job. This job can be run locally or on the cloud. We currently support the following types of jobs:
  * Command - run a command (Python, R, Windows Command, Linux Shell etc.)
  * Sweep - run a hyperparameter sweep on your Command
* Run multiple jobs using our **improved Pipelines**
  * Run a series of commands stitched into a pipeline (**New**)
  * **Components** - run pipelines using reusable components (**New**)
* Use your models for **Managed Online inferencing** (**New**)
* Use your models for Managed **batch inferencing**
* Manage AML resources – workspace, compute, datastores
* Manage AML assets - Datasets, environments, models
* **AutoML** - run standalone AutoML training for various ml-tasks:
  - Classification (Tabular data)
  - Regression (Tabular data)
  - Time Series Forecasting (Tabular data)
  - Image Classification (Multi-class) (**New**)
  - Image Classification (Multi-label) (**New**)
  - Image Object Detection (**New**)
  - Image Instance Segmentation (**New**)
  - NLP Text Classification (Multi-class) (**New**)
  - NLP Text Classification (Multi-label) (**New**)
  - NLP Text Named Entity Recognition (NER) (**New**)

## Examples

- View our [samples][ml_samples].

## Troubleshooting

### General

Azure ML clients raise exceptions defined in [Azure Core][azure_core_readme].

```python
from azure.core.exceptions import HttpResponseError

try:
    ml_client.compute.get("cpu-cluster")
except HttpResponseError as error:
    print("Request failed: {}".format(error.message))
```

### Logging

This library uses the standard
[logging][python_logging] library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.

Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the `logging_enable` argument.

See full SDK logging documentation with examples [here][sdk_logging_docs].

### Telemetry

The Azure ML Python SDK includes a telemetry feature that collects usage and failure data about the SDK and sends it to Microsoft when you use the SDK in a Jupyter Notebook only.
<u>Telemetry will **not** be collected for any use of the Python SDK outside of a Jupyter Notebook.</u>

Telemetry data helps the SDK team understand how the SDK is used so it can be improved and the information about failures helps the team resolve problems and fix bugs.
The SDK telemetry feature is enabled by default for Jupyter Notebook usage and cannot be enabled for non-Jupyter scenarios. To opt out of the telemetry feature in a Jupyter scenario, pass in `enable_telemetry=False` when constructing your MLClient object.

## Next steps

- View our [samples][ml_samples].

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.

<!-- LINKS -->

[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ml/azure-ai-ml
[ml_pypi]: https://pypi.org/project/azure-ai-ml/
[ml_conda]: https://anaconda.org/microsoft/azure-ai-ml/
[ml_ref_docs]: https://learn.microsoft.com/python/api/azure-ai-ml/?view=azure-python
[ml_samples]: https://github.com/Azure/azureml-examples/tree/main/sdk/python
[product_documentation]: https://learn.microsoft.com/azure/machine-learning/
[azure_subscription]: https://azure.microsoft.com/free/
[workspace]: https://learn.microsoft.com/azure/machine-learning/concept-workspace
[python_logging]: https://docs.python.org/3/library/logging.html
[sdk_logging_docs]: https://learn.microsoft.com/azure/developer/python/azure-sdk-logging
[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
[pip_link]: https://pypi.org/project/pip/
[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity
[cla]: https://cla.microsoft.com
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[coc_contact]: mailto:opencode@microsoft.com


# Release History

## 1.31.0 (2025-12-30)

### Features Added

- Added support for `default_deployment_template` property in Model entity, allowing models to specify a default deployment template for online deployments.
- Online deployments now display informational messages when deploying models with configured default deployment templates.

### Other Changes

- Ensuring that azureml-dataprep-rslex is only installed for PyPy below 3.10 and CPython below 3.13.
- Adding support for Python 3.14.
- Dropping support for Python 3.7 and 3.8.
- Update the deployment template parameter `allowed_instance_type` -> `allowed_instance_types`

## 1.30.0 (2025-10-29)

### Features Added

- Removed the dependencies - msrest and six
- Added support for `Deployment Templates` along with the following operations:
  - `ml_client.deployment_templates.create_or_update()`
  - `ml_client.deployment_templates.list()`
  - `ml_client.deployment_templates.get()`
  - `ml_client.deployment_templates.archive()`
  - `ml_client.deployment_templates.restore()`

## 1.29.0 (2025-09-01)

### Features Added

- Removed the dependencies - msrest and six
- Added support for `Deployment Templates` along with the following operations:
  - `ml_client.deployment_templates.create_or_update()`
  - `ml_client.deployment_templates.list()`
  - `ml_client.deployment_templates.get()`
  - `ml_client.deployment_templates.archive()`
  - `ml_client.deployment_templates.restore()`

### Bugs Fixed

- Fix for registry resource group passed to OnlineEndpointOperations when model is in registry in different resource group compared to workspace.
- Set defaults for min_instances, max_instances, idle_time_before_scale_down in AmlCompute

### Other Changes

- v2 component types are now case insensitive

## 1.28.1 (2025-07-08)

### Features Added

- Added a workflow to create GitHub issues in case a major version of a dependency is released

## 1.27.1 (2025-05-13)

### Bugs Fixed

- Handle key error for missing props in PAT url case.

## 1.27.0 (2025-05-07)

### Features Added

- Added Target storage connection for capability host.

### Bugs Fixed

- Fix for compute Instance, disableLocalAuth property should be depend on ssh public access enabled.
- Removing Git-related properties from job properties if a PAT token is detected in the repository URL.
- Fix deployment creation for registry models

### Other Changes

- Hub and Project are officially GA'd and no longer experimental.
- PipelineComponentBatchDeployment, ModelBatchDeployment, ModelBatchDeploymentSettings are GA

## 1.26.4 (2025-04-23)

### Other Changes

- Restrict major version auto updates for external dependencies to ensure stability and prevent build failures for breaking changes.

## 1.26.3 (2025-04-17)

### Bugs Fixed

- Updated `marshmallow` dependency to restrict versions to `>=3.5,<4.0.0`
  in `install_requires` to ensure compatibility.

## 1.26.2 (2025-04-08)

### Bugs Fixed

- Made AI Search connections property optional while creating capability host.

## 1.26.1 (2025-03-27)

### Bugs Fixed

- Handle missing duration value in deployment poller result

## 1.26.0 (2025-03-11)

### Features Added

- Adding parent job support for command job.
- Adding multiple docker argument support for command job.

### Bugs Fixed

- #37464 - Allowing to update a component in register with anonymousEnvironment environment.
- #39744 - Fixing a serialization issue in RecurrencePattern schedule.
- #39793 - Fixing bug in AML OBO to work with KV secret client.
- Fix environment archiving and restore

### Other Changes

- Removing use of protected methods/classes imported from external libraries.

## 1.25.0 (2025-02-11)

### Features Added

### Bugs Fixed

- #39187 - Submitting a Command job created using the __call__ method on another Command is missing outputs.
- #37738 - documentation fix for deployment entities.

### Other Changes

- Adding support for Python 3.13. Ensuring that azureml-dataprep-rslex is only installed for Python versions below 3.13. This change may break if `Annotated` used directly without parameters.

## 1.24.0 (2025-01-07)

### Bugs Fixed

- Fixed disableLocalAuthentication handling while creating amlCompute
- Fixed model download issue

## 1.23.1 (2025-01-07)

### Bugs Fixed

- Removed marshmallow _T reference

## 1.23.0 (2024-12-05)

### Features Added

- Added support for IP-based access control to default and hub workspaces.
- Add support for additional include in spark component.
- Adding enterprise agent feature for AI Hub and AI Project. Adding Create, Delete and Get operations.
- Removing preview tag for following connections type
  - Azure AI Search
  - Azure AI Content Safety
  - Azure AI Speech
  - Azure Blob Storage
  - Microsoft OneLake

## 1.22.3 (2024-11-20)

### Bugs Fixed

- Fix error message while resolving mlflow url in get workspace details

## 1.22.2 (2024-11-18)

### Bugs Fixed

- **#3620407** - Fix Datastore credentials show up as NoneCredentials

## 1.22.1 (2024-11-13)

### Bugs Fixed

- **#38493** - Fix error NoneType object is not subscriptable

## 1.22.0 (2024-11-11)

### Features Added

- Added support to select firewall sku to used for provisioning azure firewall when FQDN rules are added in
  AllowOnlyApprovedOutbound mode. FirewallSku options are `Standard` or `Basic`, defaults to `Standard`
- Update TLS version from 1.0 to 1.2
- Added support for Distillation jobs. Can be created by importing `disillation` from `azure.ai.ml.model_customization`
- Added Workspace property `ProvisionNetworkNow` to trigger the provisioning of the managed VNet with the default
  Options when creating a Workspace with the managed VNet enabled, or else it does nothing

### Bugs Fixed

- Fix send email notification issue in model monitoring

## 1.21.1 (2024-10-21)

### Bugs Fixed

- **#37857** - Fix online deployment registry issue

## 1.21.0 (2024-09-30)

### Features Added

- Cross subscription storage account support for workspace and feature store. Developer can provide a storage account from another subscription while creating a workspace or storage account.

### Bugs Fixed

- #35820 - using compute location attribute to fill compute location to align the experience with UI.

## 1.20.0 (2024-09-10)

### Features Added

- When a workspace is created with `managed_network` enabled or has `public_network_access` set to disabled, the resources created with the workspace (Key Vault, Storage Account) will be set to have restricted network access settings. This is only applicable when the user does not specify existing resources.
- Added support of `fqdns` property for managed network `PrivateEndpointDestination` outbound rule objects. Enabling the support of Application Gateway as a Private Endpoint target in the workspace managed network.
- Added support of `address_prefixes` property for managed network `ServiceTagDestination` outbound rule objects.
- Removed experimental tag from `managed_network` which is a GA feature.

## 1.19.0 (2024-07-29)

### Feature Added

- Added enable_sso operation under compute operation that will allow user to enable sso setting of a compute instance without any write permission set on compute.

### Bugs Fixed

- Workspace update no longer broken for older workspaces due to deprecated tags.
- Support credential-less fileshare datastore

## 1.18.0 (2024-07-09)

### Features Added

- Expose `public_ip_address` in `AmlComputeNodeInfo`, to get the public ip address with the ssh port when calling `ml_client.compute.list_nodes`
- Uploads to account key access datastores will be authorized via a SAS token retrieved from a call to `DatastoreOperations._list_secrets`. Key-based authentication for uploads for such datastores is no longer used. Identity-based datastores will use user identity authentication retrieved from the MLClient.
- Support `update_sso_settings` in `ComputeOperations`, to enable or disable single sign-on settings of a compute instance.

### Bugs Fixed

- InputTypes exported in constants module
- WorkspaceConnection tags are now listed as deprecated, and the erroneously-deprecated metadata field has been un-deprecated and added as a initialization field. These two fields still point to the same underlying object property, and actual API usage of this value is unchanged.
- Workspace Create operation works without an application insights being provided, and creates a default appIn resource for normal workspaces in that case.
- Project create operations works in general.

### Other Changes

- WorkspaceConnections are officially GA'd and no longer experimental. But its much newer subclasses remain experimental.

## 1.17.1 (2024-07-04)

### Bugs Fixed

- Workspace Create operation works without an application insights being provided, and creates a default appIn resource for normal workspaces in that case.
- Project create operations works in general.

## 1.17.0 (2024-06-18)

## 1.16.0 (2024-05-14)

### Features Added

- Add experimental support for working with Promptflow evaluators: `ml_client.evaluators`.
- Many changes to the Connection entity class and its associated operations.
- Workspace Connection `list`, `get`, and `create_or_update` operations now include an optional `populate_secrets` input, which causes the operations to try making a secondary call to fill in the returned connections' credential info if possible. Only works with api key-based credentials for now.
- Many workspace connection subtypes added. The full list of subclasses is now:
  - `AzureBlobStoreConnection`
  - `AzureBlobStoreConnection`
  - `MicrosoftOneLakeConnection`
  - `AzureOpenAIConnection`
  - `AzureAIServicesConnection`
  - `AzureAISearchConnection`
  - `AzureContentSafetyConnection`
  - `AzureSpeechServicesConnection`
  - `APIKeyConnection`
  - `OpenAIConnection`
  - `SerpConnection`
  - `ServerlessConnection`
- Many workspace connections only accept api keys or entra ids for credentials. Since Entra IDs require not inputs, these have been refactored to not required a full credential object. Instead they only accept an api_key as a top-level input, and default to an entra credential otherwise. Their YAML schemas have been similarly altered.
- Client-side credential-type validation added for some workspace connection types.
- Added new credential type: `AadCredentialConfiguration`
- Renamed WorkspaceHub class as Hub.
- Added Project entity class and YAML support.
- Project and Hub operations supported by workspace operations.
- workspace list operation supports type filtering.
- Add support for Microsoft Entra token (`aad_token`) auth in `invoke` and `get-credentials` operations.
- Add experimental support for working with indexes: `ml_client.indexes`

### Bugs Fixed

### Breaking Changes

- Removed WorkspaceHubConfig entity, and renamed WorkspaceHub to Hub.
- workspace_hub input of Workspace class hidden, renamed to hub_id, and re-surfaced in child class Project.
- Removed Workspace Hub Operations from ML Client.

### Other Changes

## 1.15.0 (2024-03-26)

### Other Changes

- The following classes will still be able to be imported from `azure.ai.ml`, but the import is deprecated and emits a warning. Instead, please import them from `azure.ai.ml.entities`.
  - `AmlTokenConfiguration`
  - `ManagedIdentityConfiguration`
  - `UserIdentityConfiguration`
- The following classes will still be able to be imported from `azure.ai.ml.entities`, but the import is deprecated and emits a warning. Instead, please import them from `azure.ai.ml.sweep`.
  - `Choice`
  - `Uniform`
  - `LogUniform`
  - `QLogUniform`
  - `QUniform`
  - `QLogNormal`
  - `QNormal`
  - `LogNormal`
  - `Normal`
  - `Randint`

## 1.14.0 (2024-03-11)

### Features Added

- Remove `experimental` tag for  `ml_client.jobs.validate`.
- Workspace Connection has new read-only subclass: AzureBlobStoreWorkspaceConnectionSchema.
- Workspace Connection supports 2 new types under main class: gen 2 and azure_one_lake.
- Workspace Connection LIST operation can return data connections via new optional flag: include_data_connections.
- Support `ml_client.schedules.trigger(name='my_schedule')` function to trigger a schedule once.

### Bugs Fixed

- Fix pipeline job `outputs` not load correctly when `component: <local-file>` exists in pipeline job yaml.
- Workspace ListKey operation serialization issue fixed.
- Workspace Diagnose result now can be print in to Json format.

### Breaking Changes

### Other Changes

- Support for Python 3.12

## 1.13.0 (2024-01-29)

### Features Added

### Bugs Fixed

### Breaking Changes

### Other Changes

## 1.12.0 (2023-11-13)

### Features Added

- Workspace Connections had 3 child classes added for open AI, cog search, and cog service connections.
- Workspace Connections replaced metadata with tags, and surfaced api_version, api_type, and kind for certain connection types.

### Bugs Fixed

- Workspace Hubs now properly create various endpoints, and surface a variable to select the resource they connect to via the
  'endpoint_resource_id' kwarg.

### Breaking Changes

### Other Changes

## 1.11.1 (2023-10-13)

### Bugs Fixed

- pydash dependency version was upgraded to >=6.0.0 to patch [security vulnerability in versions below 6.0.0](https://github.com/advisories/GHSA-8mjr-6c96-39w8)
- Workspace hub deletion no longer fails if delete_dependent_resources is true.

## 1.11.0 (2023-10-04)

### Features Added

- Now, when you specify `delete_dependent_resources` as True when deleting a workspace, the log analytics resource
  associated with the workspace application insights resource will also be deleted.
- Now, when creating or updating a workspace, you can provide a `serverless_compute` configuration object. This allows configuring a custom subnet in which all Serverless computes will be created. You can also specify whether or not these Serverless computes will have public IP addresses or not.

### Breaking Changes

- [Python 3.7 reached end-of-life on June 27th 2023](https://devguide.python.org/versions/). Consequently, 3.7 will be deprecated in azure-ai-ml starting in October 2023 and azure-ai-ml will end support for 3.7 in February 2024.

## 1.10.1 (2023-09-17)

### Bugs Fixed

- Feature sets can now be registers after being dumped and reloaded.
- SDK feature store create/update can now assign materialization identities to cross RG offline stores and online stores.

## 1.10.0 (2023-09-07)

### Features Added

- Added support of features that are known into the future/at forecast time for dnn in AutoML Forecasting jobs.
- Added support for new workspace connection types: azure_open_ai, cognitive_search, and cognitive_service.
- Added support for new credential type: ApiKeyConfiguration.
- Added support of `download` for component operations.

### Bugs Fixed

- Local job runs will no longer fail if Docker registry has no username/password
- Fixed an issue that code asset doesn't work with relative symbol links.
- Fixed [Issue 31319](https://github.com/Azure/azure-sdk-for-python/issues/31319): can't accept `PathLike` for `CommandComponent.code`.

### Other Changes

- `azure-ai-ml` now performs all file i/o on `utf-8` encoded files per Azure SDK guidance.
  (instead of the default behavior for python < 3.15, which uses locale specific encodings)
- Removed references to deprecated "feature_store" workspace connection type.

## 1.9.0 (2023-07-25)

### Features Added

- Added support to enable gpu access (local_enable_gpu) for local deployment.

### Other Changes

- Improved the output when printing a workspace object to be more clean and readable.
- Log level of unknown field notifications for pipeline nodes raised from INFO to WARNING.

## 1.8.0 (2023-06-12)

### Features Added

- Added support to enable set workspace connection secret expiry time.
- Added support for `stage` on model version

### Bugs Fixed

- Fixed an issue affecting authentication to registry-related services in sovereign regions.
- Made job_tier and priority values case insensitive

## 1.7.2 (2023-05-18)

### Features Added

- Public preview support for new schedule type `MonitorSchedule`

## 1.7.1 (2023-05-17)

### Bugs Fixed

- Fixed an issue where `OnlineDeployment.provisioning_state` was incorrectly deserialized and set as `None`

## 1.7.0 (2023-05-15)

### Features Added

- Added data import schedule. The class added is `ImportDataSchedule`.
- Added support to enable data isolation feature at workspace creation stage.
- Added auto_delete_setting support for asset version in data import job.
- Switched code snapshot upload from directory-based to container-based design in order to allow finer RBAC within workspaces. A container will be created for each new snapshot. This change does not affect storage costs or snapshot functionality.

### Bugs Fixed

### Breaking Changes

### Other Changes

## 1.6.0 (2023-05-01)

### Features Added

- Added experimental scatter gather node to DSL package. This node has a unique mldesigner dependency.
- Added support to make JobService and ServiceInstance objects serializable when printed
- Support Singularity compute in pipeline job
- Added purge operation support for workspace resource
- Added Feature Store, its dedicated classes and updated the docstrings, now available in public interface. The classes added are `FeatureStoreOperations, FeatureSetOperations, FeatureStoreEntityOperations` with properties classes specific to the new features.
- Support additional_includes in command component
- Added experimental `distribution: ray` support in command job.

### Bugs Fixed

- Fixed issue where show_progress=False was not being respected for uploads when set via MLClient
- Fixed issue of spark input/output mode validation doesn't take effect because of wrong type assertion
- Fixed the bug when setting `node.limits.timeout` to a pipeline input.
- Removed Experimental Tag from Idle Shutdown, Custom Applications, Setup Scripts, and Image Metadata on Compute Instances.
- Removed Experimental Tag from JobService classes

### Breaking Changes

- Renamed `JobServiceBase.job_service_type` to `type`

### Other Changes

- Remove the default placeholder for CommandComponent.code

## 1.5.0 (2023-03-20)

### Features Added

- Added support for `tags` on Compute Resources.
- Added support for promoting data asset from a workspace to a registry
- Added support for registering named asset from job output or node output by specifying name and version settings.
- Added support for data binding on outputs inside dynamic arguments for dsl pipeline
- Added support for serverless compute in pipeline, command, automl and sweep job
- Added support for `job_tier` and `priority` in standalone job
- Added support for passing `locations` via command function and set it to `JobResourceConfiguration.locations`
- Added support for modifying SSH key values after creation on Compute Resources.
- Added WorkspaceConnection types `s3`, `snowflake`, `azure_sql_db`, `azure_synapse_analytics`, `azure_my_sql_db`, `azure_postgres_db`
- Added WorkspaceConnection auth type `access_key` for `s3`
- Added DataImport class and DataOperations.import_data.
- Added DataOperations.list_materialization_status - list status of data import jobs that create asset versions via asset name.

### Bugs Fixed

- Fix experiment name wrongly set to 'Default' when schedule existing job.
- Error message improvement when a local path fails to match with data asset type.
- Error message improvement when an asset does not exist in a registry
- Fix an issue when submit spark pipeline job with referring a registered component
- Fix an issue that prevented Job.download from downloading the output of a BatchJob

### Other Changes

- Added dependency on `azure-mgmt-resource`
- Added dependency on `azure-mgmt-resourcegraph`
- Added dependency on `opencensus-ext-azure<2.0.0`
- Update job types to use MFE Dec preview rest objects.
- Added classifiers for Python version 3.11.
- Added warning for reserved keywords in IO names in pipeline job nodes.
- Added telemetry logging for SDK Jupyter Notebook scenarios with opt-out option (see README.md)

## 1.4.0 (2023-02-07)

### Features Added

- Added dedicated classes for each type of job service and updated the docstrings. The classes added are `JupyterLabJobService, SshJobService, TensorBoardJobService, VsCodeJobService` with a few properties specific to the type.
- Added Custom Applications Support to Compute Instances.
- Update data asset list, show and create operations to support data assets in registry.
- Added Managed Network features to workspace to include `ManagedNetwork`, `FqdnDestination`, `PrivateEndpointDestination`, `ServiceTagDestination` as well as relevant schema.

### Bugs Fixed

- Fixed an issue where the ordering of `.amlignore` and `.gitignore` files are not respected.
- Fixed an issue that attributes with a value of `False` in `PipelineJobSettings` are not respected.
- Fixed an issue where ignore files weren't considered during upload directory size calculations.
- Fixed an issue where symlinks crashed upload directory size calculations.
- Fixes a bug where enable_node_public_ip returned an improper value when fetching a Compute.

### Other Changes

- Update workspace creation to use Log Analytics-Based Application Insights when the user does not specify/bring their own App Insights.
- Upgraded minimum azure-core version to 1.23.0.

## 1.3.0 (2023-01-13)

### Features Added

- Change print behavior of entity classes to show object yaml in notebooks, can be configured on in other contexts.
- Added property to enable/disable public ip addresses to Compute Instances and AML Computes.
- `Deployment` and `ScheduleOperations` added to public interface.

### Bugs Fixed

- Fixed issue with date-time format for utc_time_created field when creating models.
- Added stricter behavior for ArmStr schemas when parsing 'azureml:' prefix.
- Fixed issue where AmlComputes could only be created in a workspace's default region.
- Improved intellisense with VS Code for fields supporting local paths and datastores.
- Added validation for token generation with aml scope when user_identity is used in job definition aka OBO flow.
- Fixed duplicate node name error in pipeline when two node names assigned to the same node and get renamed by node.name='xx'.
- Resolve the cross references for MLClient, Resource and OnlineDeployment.
- Explicit use of Optional (or a Union with None), as per PEP 484.
- Fixed print on Command objects when job id is empty
- Fixed issue where `SasTokenConfiguration` cannot be used as credential for `WorkspaceConnection`

### Other Changes

- Removed dependency on API version 2021-10-01 and 2022-06-01-preview to reduce side of azure-ai-ml package.

## 1.2.0 (2022-12-05)

### Breaking Changes

- Removed description from Registry.
- Disable sdk telemetry logging

### Features Added

- Enable updating the CMK encryption key (workspace.encryption.keyVaultProperties.keyIdentifier) for a workspace.
- Mark JobService class and services param to command() as experimental.
- Added a replication_count value to the schema of SystemCreatedStorageAccount in Registry.
- Added support for Fairfax and MoonCake cloud for the registry discovery baseurl.
- Added support for variable args as pipeline input in DSL Pipeline.
- Added OS Patching Parameters to Compute Instance.

### Bugs Fixed

- Update the upper bound dependencies version for tqdm, strictyaml, colorama and opencensus-ext-azure.
- Added missing "properties" to batch deployment.
- Retain the cases for the names of system job services (Tracking and Studio).
- Update registry begin_delete method return type.
- Fixed sweep job optional input cannot be empty.
- Fixed bool test for output in download operation.
- Fixed Compute Instance schedule not being created
- Removed erroneous experimental warning from Compute Schedules

## 1.1.2 (2022-11-21)

### Features Added

- Restored idle_time_before_shutdown property for Compute Instances.
- Deprecated idle_time_before_shutdown property in favor of idle_time_before_shutdown_minutes.

### Bugs Fixed

- Fixed idle_time_before_shutdown appearing as None for Compute Instances returned by `show` or `list`.
- Fixed idle_time_before_shutdown_minutes preventing creation of Compute Instances when set to None.

## 1.1.1 (2022-11-15)

### Breaking Changes

- Renamed idle_time_before_shutdown to idle_time_before_shutdown_minutes and changed input type to int.

### Bugs Fixed

- Fixed idle_time_before_shutdown_minutes not appearing in GET calls for Compute Instances.

## 1.1.0 (2022-11-07)

### Features Added

- Registry list operation now accepts scope value to allow subscription-only based requests.
- Most configuration classes from the entity package now implement the standard mapping protocol.
- Add registry delete operation.
- The values of JobService.job_service_type are now using the snake case. e.g jupyter_lab, ssh, tensor_board, vs_code.
- Command function now accepts services param of type Dict[str, JobService] instead of dict.

### Bugs Fixed

- MLClient.from_config can now find the default config.json on Compute Instance when running sample notebooks.
- Fixed job inputs not accepting datastores or job inputs.
- Registries now assign managed tags to match registry's tags.
- Adjust registry experimental tags and imports to avoid warning printouts for unrelated operations.
- Make registry delete operation return an LROPoller, and change name to begin_delete.
- Prevent registering an already existing environment that references conda file.
- Fix ARM ID logic for registry environments (ex: Creating a registry component that references a registry environment).
- Fix ARM ID logic for passing models and environments with ID (ex: Creating endpoint deployment for a registry model should return said model's ID immediately)

### Other Changes

- Switched compute operations to go through 2022-10-01-preview API version.

## 1.0.0 (2022-10-10)

- GA release
- Dropped support for Python 3.6. The Python versions supported for this release are 3.7-3.10.

### Features Added

### Breaking Changes

- OnlineDeploymentOperations.delete has been renamed to begin_delete.
- Datastore credentials are switched to use unified credential configuration classes.
- UserAssignedIdentity is replaced by ManagedIdentityConfiguration
- Endpoint and Job use unified identity classes.
- Workspace ManagedServiceIdentity has been replaced by IdentityConfiguration.

### Other Changes

- Switched Compute operations to use Oct preview API version.
- Updated batch deployment/endpoint invoke and list-jobs function signatures with curated BatchJob class.

## 0.1.0b8 (2022-10-07)

### Features Added

- Support passing JobService as argument to Command()
- Added support for custom setup scripts on compute instances.
- Added a `show_progress` parameter to MLClient for enable/disable progress bars of long running operations.
- Support `month_days` in `RecurrencePattern` when using `RecurrenceSchedule`.
- Support `ml_client.schedules.list` with `list_view_type`, default to `ENABLED_ONLY`.
- Add support for model sweeping and hyperparameter tuning in AutoML NLP jobs.
- Added `ml_client.jobs.show_services()` operation.

### Breaking Changes

- ComputeOperations.attach has been renamed to begin_attach.
- Deprecated parameter path has been removed from load and dump methods.
- JobOperations.cancel() is renamed to JobOperations.begin_cancel() and it returns LROPoller
- Workspace.list_keys renamed to Workspace.get_keys.

### Bugs Fixed

- Fix identity passthrough job with single file code
- MLClient.from_config can now find the default config.json on Compute Instance when running sample notebooks.

### Other Changes

- Removed declaration on Python 3.6 support
- Added support for custom setup scripts on compute instances.
- Updated dependencies upper bounds to be major versions.

## 0.1.0b7 (2022-09-22)

### Features Added

- Spark job submission.
- Command and sweep job docker config (shmSize and dockerArgs) spec support.
- Entity load and dump now also accept a file pointer as input.
- Load and dump input names changed from path to 'source' and 'dest', respectively.
- Load and dump 'path' input still works, but is deprecated and emits a warning.
- Managed Identity Support for Compute Instance (experimental).
- Enable using @dsl.pipeline without brackets when no additional parameters.
- Expose Azure subscription Id and resource group name from MLClient objects.
- Added Idle Shutdown support for Compute Instances, allowing instances to shutdown after a set period of inactivity.
- Online Deployment Data Collection for eventhub and data storage will be supported.
- Syntax validation on scoring scripts of Batch Deployment and Online Deployment will prevent the user from submitting bad deployments.

### Breaking Changes

- Change (begin_)create_or_update typehints to use generics.
- Remove invalid option from create_or_update typehints.
- Change error returned by (begin_)create_or_update invalid input to TypeError.
- Rename set_image_model APIs for all vision tasks to set_training_parameters
- JobOperations.download defaults to "." instead of Path.cwd()

### Bugs Fixed

### Other Changes

- Show 'properties' on data assets

## 0.1.0b6 (2022-08-09)

### Features Added

- Support for AutoML Component
- Added skip_validation for Job/Component create_or_update

### Breaking Changes

- Dataset removed from public interface.

### Bugs Fixed

- Fixed mismatch errors when updating scale_settings for KubernetesOnlineDeployment.
- Removed az CLI command that was printed when deleting OnlineEndpoint

## 0.1.0b5 (2022-07-15)

### Features Added

- Allow Input/Output objects to be used by CommandComponent.
- Added MoonCake cloud support.
- Unified inputs/outputs building and validation logic in BaseNode.
- Allow Git repo URLs to be used as code for jobs and components.
- Updated AutoML YAML schema to use InputSchema.
- Added end_time to job schedule.
- MIR and pipeline job now support registry assets.

### Bugs Fixed

- Have mldesigner use argparser to parse incoming args.
- Bumped pyjwt version to <3.0.0.
- Reverted "upload support for symlinks".
- Error message improvement when a YAML UnionField fails to match.
- Reintroduced support for symlinks when uploading.
- Hard coded registry base URL to eastus region to support preview.

## 0.1.0b4 (2022-06-16)

## 0.1.0b3 (2022-05-24)

### Features Added

- First preview.