[ML] AOAI Deployment List (#35417)

* list aoai deployments no translation working

* list aoai deployments with translation working, just need to add target url and connection name

* lint

* add connection name and target to deployment response

* run black on files

Author: needuv

sdk/ml/azure-ai-ml/azure/ai/ml/_ml_client.py

@@ -73,6 +73,7 @@
 from azure.ai.ml.entities._assets import WorkspaceAssetReference
 from azure.ai.ml.exceptions import ErrorCategory, ErrorTarget, ValidationException
 from azure.ai.ml.operations import (
+    AzureOpenAIDeploymentOperations,
     BatchDeploymentOperations,
     BatchEndpointOperations,
     ComponentOperations,
@@ -360,6 +361,13 @@ def __init__(
             **kwargs,
         )
 
+        self._service_client_04_2024_preview = ServiceClient042024Preview(
+            credential=self._credential,
+            subscription_id=self._operation_scope._subscription_id,
+            base_url=base_url,
+            **kwargs,
+        )
+
         # A general purpose, user-configurable pipeline for making
         # http requests
         self._requests_pipeline = HttpPipeline(**kwargs)
@@ -686,6 +694,12 @@ def __init__(
             self._service_client_10_2023,
             **ops_kwargs,  # type: ignore[arg-type]
         )
+        self._azure_openai_deployments = AzureOpenAIDeploymentOperations(
+            self._operation_scope,
+            self._operation_config,
+            self._service_client_04_2024_preview,
+            self._connections,
+        )
 
         self._serverless_endpoints = ServerlessEndpointOperations(
             self._operation_scope,
@@ -1042,6 +1056,16 @@ def indexes(self) -> IndexOperations:
         """
         return self._indexes
 
+    @property
+    @experimental
+    def azure_openai_deployments(self) -> AzureOpenAIDeploymentOperations:
+        """A collection of Azure OpenAI deployment related operations.
+
+        :return: Azure OpenAI deployment operations.
+        :rtype: ~azure.ai.ml.operations.AzureOpenAIDeploymentOperations
+        """
+        return self._azure_openai_deployments
+
     @property
     def subscription_id(self) -> str:
         """Get the subscription ID of an MLClient object.

sdk/ml/azure-ai-ml/azure/ai/ml/entities/__init__.py

@@ -39,7 +39,12 @@
 from ._assets.environment import BuildContext, Environment
 from ._assets.intellectual_property import IntellectualProperty
 from ._assets.workspace_asset_reference import WorkspaceAssetReference as WorkspaceModelReference
-from ._autogen_entities.models import MarketplaceSubscription, ServerlessEndpoint, MarketplacePlan
+from ._autogen_entities.models import (
+    AzureOpenAIDeployment,
+    MarketplaceSubscription,
+    ServerlessEndpoint,
+    MarketplacePlan,
+)
 from ._builders import Command, Parallel, Pipeline, Spark, Sweep
 from ._component.command_component import CommandComponent
 from ._component.component import Component
@@ -480,6 +485,7 @@
     "AccountKeyConfiguration",
     "AadCredentialConfiguration",
     "Index",
+    "AzureOpenAIDeployment",
 ]
 
 # Allow importing these types for backwards compatibility

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_autogen_entities/models/__init__.py

@@ -6,12 +6,13 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
+from ._models import AzureOpenAIDeployment
 from ._models import ServerlessEndpoint
 from ._models import MarketplaceSubscription
 from ._patch import __all__ as _patch_all
 from ._patch import *  # pylint: disable=unused-wildcard-import
 from ._patch import patch_sdk as _patch_sdk
 
-__all__ = ["ServerlessEndpoint", "MarketplaceSubscription"]
+__all__ = ["AzureOpenAIDeployment", "ServerlessEndpoint", "MarketplaceSubscription"]
 __all__.extend([p for p in _patch_all if p not in __all__])
 _patch_sdk()

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_autogen_entities/models/_models.py

@@ -17,6 +17,43 @@
     from .. import models as _models
 
 
+class AzureOpenAIDeployment(_model_base.Model):
+    """Azure OpenAI Deployment Information.
+
+    Readonly variables are only populated by the server, and will be ignored when sending a request.
+
+    :ivar name: The deployment name.
+    :vartype name: str
+    :ivar model_name: The name of the model to deploy.
+    :vartype model_name: str
+    :ivar model_version: The model version to deploy.
+    :vartype model_version: str
+    :ivar connection_name: The name of the connection to deploy to.
+    :vartype connection_name: str
+    :ivar target_url: The target URL of the AOAI resource for the deployment.
+    :vartype target_url: str
+    :ivar id: The ARM resource id of the deployment.
+    :vartype id: str
+    :ivar properties: Properties of the deployment.
+    :vartype properties: dict[str, str]
+    :ivar tags: Tags of the deployment.
+    :vartype tags: dict[str, str]
+    """
+
+    name: Optional[str] = rest_field(visibility=["read"])
+    """The deployment name."""
+    model_name: Optional[str] = rest_field(visibility=["read"])
+    """The name of the model to deploy."""
+    model_version: Optional[str] = rest_field(visibility=["read"])
+    """The model version to deploy."""
+    connection_name: Optional[str] = rest_field(visibility=["read"])
+    """The name of the connection to deploy to."""
+    target_url: Optional[str] = rest_field(visibility=["read"])
+    """The target URL of the AOAI resource for the deployment."""
+    id: Optional[str] = rest_field(visibility=["read"])
+    """The ARM resource id of the deployment."""
+
+
 class MarketplacePlan(_model_base.Model):
     """Marketplace Subscription Definition.
 

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_autogen_entities/models/_patch.py

@@ -14,6 +14,10 @@
 
 from azure.ai.ml.entities._system_data import SystemData
 from azure.ai.ml._utils._experimental import experimental
+from azure.ai.ml._restclient.v2024_04_01_preview.models import (
+    EndpointDeploymentResourcePropertiesBasicResource,
+    OpenAIEndpointDeploymentResourceProperties,
+)
 from azure.ai.ml._utils.utils import camel_to_snake
 from azure.ai.ml._restclient.v2024_01_01_preview.models import (
     ServerlessEndpoint as RestServerlessEndpoint,
@@ -25,20 +29,23 @@
 )
 
 from ._models import (
+    AzureOpenAIDeployment as _AzureOpenAIDeployment,
     ServerlessEndpoint as _ServerlessEndpoint,
     MarketplaceSubscription as _MarketplaceSubscription,
     MarketplacePlan as _MarketplacePlan,
 )
 from .._model_base import rest_field
 
 __all__: List[str] = [
+    "AzureOpenAIDeployment",
     "ServerlessEndpoint",
     "MarketplaceSubscription",
     "MarketplacePlan",
 ]  # Add all objects you want publicly available to users at this package level
 
 _NULL = object()
 
+
 func_to_attr_type = {
     "_deserialize_dict": dict,
     "_deserialize_sequence": list,
@@ -81,6 +88,38 @@ def _validate(self) -> None:
                     raise ValueError(f"Type of attr {attr} is of type {attr_type}, not {rest_field_type}")
 
 
+@experimental
+class AzureOpenAIDeployment(_AzureOpenAIDeployment):
+
+    system_data: Optional[SystemData] = rest_field(visibility=["read"])
+    """System data of the deployment."""
+
+    @classmethod
+    def _from_rest_object(cls, obj: EndpointDeploymentResourcePropertiesBasicResource) -> "AzureOpenAIDeployment":
+        properties: OpenAIEndpointDeploymentResourceProperties = obj.properties
+        return cls(
+            name=obj.name,
+            model_name=properties.model.name,
+            model_version=properties.model.version,
+            id=obj.id,
+            system_data=SystemData._from_rest_object(obj.system_data),
+        )
+
+    def as_dict(self, *, exclude_readonly: bool = False) -> Dict[str, Any]:
+        d = super().as_dict(exclude_readonly=exclude_readonly)
+        d["system_data"] = json.loads(json.dumps(self.system_data._to_dict()))  # type: ignore
+        return d
+
+
+AzureOpenAIDeployment.__doc__ += (
+    _AzureOpenAIDeployment.__doc__.strip()  # type: ignore
+    + """
+    :ivar system_data: System data of the deployment.
+    :vartype system_data: ~azure.ai.ml.entities.SystemData
+"""
+)
+
+
 @experimental
 class MarketplacePlan(_MarketplacePlan):
     pass

sdk/ml/azure-ai-ml/azure/ai/ml/operations/__init__.py

@@ -9,6 +9,7 @@
 __path__ = __import__("pkgutil").extend_path(__path__, __name__)
 
 
+from ._azure_openai_deployment_operations import AzureOpenAIDeploymentOperations
 from ._batch_deployment_operations import BatchDeploymentOperations
 from ._batch_endpoint_operations import BatchEndpointOperations
 from ._component_operations import ComponentOperations
@@ -56,4 +57,5 @@
     "ServerlessEndpointOperations",
     "MarketplaceSubscriptionOperations",
     "IndexOperations",
+    "AzureOpenAIDeploymentOperations",
 ]

sdk/ml/azure-ai-ml/azure/ai/ml/operations/_azure_openai_deployment_operations.py

@@ -0,0 +1,46 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+# pylint: disable=protected-access
+
+import logging
+from typing import Iterable
+
+from azure.ai.ml._restclient.v2024_04_01_preview import AzureMachineLearningWorkspaces as ServiceClient2020404Preview
+from azure.ai.ml._scope_dependent_operations import OperationConfig, OperationScope, _ScopeDependentOperations
+from azure.ai.ml.entities._autogen_entities.models import AzureOpenAIDeployment
+
+from ._connections_operations import ConnectionsOperations
+
+module_logger = logging.getLogger(__name__)
+
+
+class AzureOpenAIDeploymentOperations(_ScopeDependentOperations):
+    def __init__(
+        self,
+        operation_scope: OperationScope,
+        operation_config: OperationConfig,
+        service_client: ServiceClient2020404Preview,
+        connections_operations: ConnectionsOperations,
+    ):
+        super().__init__(operation_scope, operation_config)
+        self._service_client = service_client.connection
+        self._connections_operations = connections_operations
+
+    def list(self, connection_name: str, **kwargs) -> Iterable[AzureOpenAIDeployment]:
+        connection = self._connections_operations.get(connection_name)
+
+        def _from_rest_add_connection_name(obj):
+            from_rest_deployment = AzureOpenAIDeployment._from_rest_object(obj)
+            from_rest_deployment.connection_name = connection_name
+            from_rest_deployment.target_url = connection.target
+            return from_rest_deployment
+
+        return self._service_client.list_deployments(
+            self._resource_group_name,
+            self._workspace_name,
+            connection_name,
+            cls=lambda objs: [_from_rest_add_connection_name(obj) for obj in objs],
+            **kwargs,
+        )