Apiview fixes may 2024 (#35469)

* re-add load_workspace_connection

* ai services create arg

* pylint and such

* apiview adjustments

* run black again

* change connection kind name

* use new assets for connections

* fix project arm template

* comments

* remove ai_serives from workspace create

* run-black

Author: MilesHolland

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

@@ -38,6 +38,7 @@
     load_registry,
     load_serverless_endpoint,
     load_workspace,
+    load_workspace_connection,
 )
 
 module_logger = logging.getLogger(__name__)
@@ -72,6 +73,7 @@
     "load_workspace",
     "load_registry",
     "load_connection",
+    "load_workspace_connection",
     "load_model_package",
     "load_marketplace_subscription",
     "load_serverless_endpoint",

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

@@ -933,6 +933,7 @@ def feature_store_entities(self) -> FeatureStoreEntityOperations:
         return self._featurestoreentities
 
     @property
+    @experimental
     def connections(self) -> ConnectionsOperations:
         """A collection of connection related operations.
 

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

@@ -803,6 +803,7 @@ def load_batch_endpoint(
     return cast(BatchEndpoint, load_common(BatchEndpoint, source, relative_origin, params_override, **kwargs))
 
 
+@experimental
 def load_connection(
     source: Union[str, PathLike, IO[AnyStr]],
     *,
@@ -842,7 +843,7 @@ def load_workspace_connection(
     relative_origin: Optional[str] = None,
     **kwargs: Any,
 ) -> Connection:
-    """Construct a connection object from yaml file.
+    """Deprecated - use 'load_connection' instead. Construct a connection object from yaml file.
 
     :param source: The local yaml source of a connection object. Must be either a
         path to a local file, or an already-open file.
@@ -861,7 +862,10 @@ def load_workspace_connection(
     :rtype: Connection
 
     """
-    return load_workspace_connection(source, relative_origin=relative_origin, **kwargs)
+    warnings.warn(
+        "the 'load_workspace_connection' function is deprecated. Use 'load_connection' instead.", DeprecationWarning
+    )
+    return load_connection(source, relative_origin=relative_origin, **kwargs)
 
 
 def load_schedule(

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_workspace/connections/connection_subtypes.py

@@ -327,6 +327,8 @@ class AzureOpenAIConnection(ApiOrAadConnection):
     def __init__(
         self,
         *,
+        azure_endpoint: str,
+        api_key: Optional[str] = None,
         api_version: Optional[str] = None,
         api_type: str = "Azure",  # Required API input, hidden to allow for rare overrides
         open_ai_resource_id: Optional[str] = None,
@@ -338,6 +340,8 @@ def __init__(
         if open_ai_resource_id is None and from_rest_resource_id is not None:
             open_ai_resource_id = from_rest_resource_id
         super().__init__(
+            azure_endpoint=azure_endpoint,
+            api_key=api_key,
             type=camel_to_snake(ConnectionCategory.AZURE_OPEN_AI),
             from_child=True,
             **kwargs,
@@ -407,6 +411,7 @@ def open_ai_resource_id(self, value: Optional[str]) -> None:
         self.tags[CONNECTION_RESOURCE_ID_KEY] = value
 
 
+@experimental
 class AzureAIServicesConnection(ApiOrAadConnection):
     """A Connection geared towards Azure AI services.
 
@@ -426,11 +431,15 @@ class AzureAIServicesConnection(ApiOrAadConnection):
     def __init__(
         self,
         *,
+        endpoint: str,
+        api_key: Optional[str] = None,
         ai_services_resource_id: str,
         **kwargs: Any,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
+            endpoint=endpoint,
+            api_key=api_key,
             type=ConnectionTypes.AZURE_AI_SERVICES,
             from_child=True,
             **kwargs,
@@ -488,11 +497,16 @@ class AzureAISearchConnection(ApiOrAadConnection):
 
     def __init__(
         self,
+        *,
+        endpoint: str,
+        api_key: Optional[str] = None,
         **kwargs: Any,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
 
         super().__init__(
+            endpoint=endpoint,
+            api_key=api_key,
             type=ConnectionTypes.AZURE_SEARCH,
             from_child=True,
             **kwargs,
@@ -520,10 +534,15 @@ class AzureContentSafetyConnection(ApiOrAadConnection):
 
     def __init__(
         self,
+        *,
+        endpoint: str,
+        api_key: Optional[str] = None,
         **kwargs: Any,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
+            endpoint=endpoint,
+            api_key=api_key,
             type=ConnectionTypes.AZURE_CONTENT_SAFETY,
             from_child=True,
             **kwargs,
@@ -548,7 +567,7 @@ class AzureSpeechServicesConnection(ApiOrAadConnection):
     :type endpoint: str
     :param api_key: The api key to connect to the azure endpoint.
         If unset, tries to use the user's Entra ID as credentials instead.
-    :type api_key: str
+    :type api_key: Optional[str]
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
     """
@@ -559,11 +578,13 @@ def __init__(
         self,
         *,
         endpoint: str,
+        api_key: Optional[str] = None,
         **kwargs: Any,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
             endpoint=endpoint,
+            api_key=api_key,
             type=ConnectionTypes.AZURE_SPEECH_SERVICES,
             from_child=True,
             **kwargs,
@@ -587,7 +608,7 @@ class APIKeyConnection(ApiOrAadConnection):
     :param api_base: The URL to target with this connection.
     :type api_base: str
     :param api_key: The API key needed to connect to the api_base.
-    :type api_key: str
+    :type api_key: Optional[str]
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
     """
@@ -596,11 +617,13 @@ def __init__(
         self,
         *,
         api_base: str,
+        api_key: Optional[str] = None,
         **kwargs,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
             api_base=api_base,
+            api_key=api_key,
             type=camel_to_snake(ConnectionCategory.API_KEY),
             allow_entra=False,
             from_child=True,
@@ -620,18 +643,21 @@ class OpenAIConnection(ApiOrAadConnection):
     :param name: Name of the connection.
     :type name: str
     :param api_key: The API key needed to connect to the Open AI.
-    :type api_key: str
+    :type api_key: Optional[str]
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
     """
 
     def __init__(
         self,
+        *,
+        api_key: Optional[str] = None,
         **kwargs,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
             type=ConnectionCategory.Open_AI,
+            api_key=api_key,
             allow_entra=False,
             from_child=True,
             **kwargs,
@@ -649,18 +675,21 @@ class SerpConnection(ApiOrAadConnection):
     :param name: Name of the connection.
     :type name: str
     :param api_key: The API key needed to connect to the Open AI.
-    :type api_key: str
+    :type api_key: Optional[str]
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
     """
 
     def __init__(
         self,
+        *,
+        api_key: Optional[str] = None,
         **kwargs,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
             type=ConnectionCategory.SERP,
+            api_key=api_key,
             allow_entra=False,
             from_child=True,
             **kwargs,
@@ -680,18 +709,23 @@ class ServerlessConnection(ApiOrAadConnection):
     :param endpoint: The serverless endpoint.
     :type endpoint: str
     :param api_key: The API key needed to connect to the endpoint.
-    :type api_key: str
+    :type api_key: Optional[str]
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
     """
 
     def __init__(
         self,
+        *,
+        endpoint: str,
+        api_key: Optional[str] = None,
         **kwargs,
     ):
         kwargs.pop("type", None)  # make sure we never somehow use wrong type
         super().__init__(
             type=ConnectionCategory.SERVERLESS,
+            endpoint=endpoint,
+            api_key=api_key,
             allow_entra=False,
             from_child=True,
             **kwargs,

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_workspace/connections/one_lake_artifacts.py

@@ -5,6 +5,7 @@
 # pylint: disable=protected-access
 
 from typing import Any
+from azure.ai.ml._utils._experimental import experimental
 
 # Dev note: Supposedly there's going to be more artifact subclasses at some point.
 # If/when that comes to pass, we can worry about adding polymorphism to these classes.
@@ -13,6 +14,7 @@
 
 # Why is this not called a "LakeHouseArtifact"?  Because despite the under-the-hood type,
 # users expect this variety to be called "OneLake".
+@experimental
 class OneLakeConnectionArtifact:
     """Artifact class used by the Connection subclass known
     as a MicrosoftOneLakeConnection. Supplying this class further

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_workspace/workspace.py

@@ -86,6 +86,9 @@ class Workspace(Resource):
     :type enable_data_isolation: bool
     :param serverless_compute: The serverless compute settings for the workspace.
     :type: ~azure.ai.ml.entities.ServerlessComputeSettings
+    :param workspace_hub: Deprecated resource ID of an existing workspace hub to help create project workspace.
+        Use the Project class instead now.
+    :type workspace_hub: Optional[str]
     :param kwargs: A dictionary of additional configuration parameters.
     :type kwargs: dict
 
@@ -119,6 +122,7 @@ def __init__(
         managed_network: Optional[ManagedNetwork] = None,
         enable_data_isolation: bool = False,
         hub_id: Optional[str] = None,  # Hidden input, surfaced by Project
+        workspace_hub: Optional[str] = None,  # Deprecated input maintained for backwards compat.
         serverless_compute: Optional[ServerlessComputeSettings] = None,
         **kwargs: Any,
     ):
@@ -156,6 +160,8 @@ def __init__(
         self.primary_user_assigned_identity = primary_user_assigned_identity
         self.managed_network = managed_network
         self.enable_data_isolation = enable_data_isolation
+        if workspace_hub and not hub_id:
+            hub_id = workspace_hub
         self.__hub_id = hub_id
         # Overwrite kind if hub_id is provided. Technically not needed anymore,
         # but kept for backwards if people try to just use a normal workspace like

sdk/ml/azure-ai-ml/tests/connection/unittests/test_connection_entity.py

@@ -481,7 +481,7 @@ def test_ws_conn_subtype_restriction(self):
                 credentials=None,
             )
         _ = AzureOpenAIConnection(
-            target="dummy_target",
+            azure_endpoint="dummy_target",
             name="dummy_connection",
             strict_typing=True,
             credentials=None,