December Connections changes to AI SDK (#33486)

* ai changes

* follow ups

* rename ai reosurce field

* remove api key conn

* disabled connection tests

* assets for ai resoruce test

* regen assets

* undo assets change

* change custom_keys to custom

* re-add skips

Author: MilesHolland

sdk/ai/azure-ai-resources/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/ml/azure-ai-ml",
-  "Tag": "python/ml/azure-ai-ml_f032d7288a"
+  "Tag": "python/ml/azure-ai-ml_77079b021d"
 }

sdk/ai/azure-ai-resources/azure/ai/resources/client/_ai_client.py

@@ -118,7 +118,7 @@ def __init__(
         # TODO add scoping to allow connections to:
         # - Create project-scoped connections
         # For now, connections are AI resource-scoped.
-        self._connections = ConnectionOperations(self._ai_resource_ml_client, **app_insights_handler_kwargs)
+        self._connections = ConnectionOperations(resource_ml_client=self._ai_resource_ml_client, project_ml_client=self._ml_client, **app_insights_handler_kwargs)
         self._mlindexes = MLIndexOperations(self._ml_client, **app_insights_handler_kwargs)
         self._ai_resources = AIResourceOperations(self._ml_client, **app_insights_handler_kwargs)
         self._deployments = DeploymentOperations(self._ml_client, self._connections, **app_insights_handler_kwargs)

sdk/ai/azure-ai-resources/azure/ai/resources/constants/__init__.py

@@ -4,10 +4,11 @@
 
 __path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore
 
-from ._common import AssetTypes, IndexInputType, IndexType
+from ._common import AssetTypes, IndexInputType, IndexType, OperationScope
 
 __all__ = [
     "AssetTypes",
     "IndexInputType",
     "IndexType",
+    "OperationScope",
 ]

sdk/ai/azure-ai-resources/azure/ai/resources/constants/_common.py

@@ -28,3 +28,11 @@ class IndexInputType(object):
 class IndexType(object):
     ACS = "acs"
     FAISS = "faiss"
+
+class OperationScope:
+    """
+        Some AI Client Operations can be applied to either the client's AI resource,
+    or its project. For such operations, this is used to determine that scope.
+    """
+    AI_RESOURCE = "ai_resource"
+    PROJECT = "project"

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

@@ -11,6 +11,8 @@
     AzureOpenAIConnection,
     AzureAISearchConnection,
     AzureAIServiceConnection,
+    GitHubConnection,
+    CustomConnection,
 )
 from .mlindex import Index
 from .project import Project
@@ -27,5 +29,7 @@
     "AIResource",
     "Data",
     "AzureOpenAIModelConfiguration",
+    "GitHubConnection",
+    "CustomConnection",
 ]
 

sdk/ai/azure-ai-resources/azure/ai/resources/entities/ai_resource.py

@@ -31,7 +31,7 @@ def __init__(
         public_network_access: Optional[str] = None,
         identity: Optional[IdentityConfiguration] = None,
         primary_user_assigned_identity: Optional[str] = None,
-        default_workspace_resource_group: Optional[str] = None,  # Unpacked WorkspaceHubConfig field
+        default_project_resource_group: Optional[str] = None,  # Unpacked WorkspaceHubConfig field
         **kwargs,
     ):
         self._workspace_hub = WorkspaceHub(
@@ -49,7 +49,7 @@ def __init__(
             primary_user_assigned_identity=primary_user_assigned_identity,
             workspace_hub_config=WorkspaceHubConfig(
                 additional_workspace_storage_accounts=[],
-                default_workspace_resource_group=default_workspace_resource_group,
+                default_workspace_resource_group=default_project_resource_group,
             ),
             **kwargs,
         )
@@ -70,7 +70,15 @@ def _from_v2_workspace_hub(cls, workspace_hub: WorkspaceHub) -> "AIResource":
         resource._workspace_hub = workspace_hub
         return resource
 
-    # TODO test all accessors/setters
+    @property
+    def id(self) -> str:
+        """The read-only id of the resource. Set by the backend.
+
+        :return: ID of the resource.
+        :rtype: str
+        """
+        return self._workspace_hub.id
+    
     @property
     def name(self) -> str:
         """The name of the resource.
@@ -332,17 +340,17 @@ def enable_data_isolation(self) -> str:
         return self._workspace_hub.enable_data_isolation
 
     @property
-    def default_workspace_resource_group(self) -> str:
-        """The default_workspace_resource_group of the resource.
+    def default_project_resource_group(self) -> str:
+        """The default_project_resource_group of the resource.
 
         :return: Name of the resource.
         :rtype: str
         """
         return self._workspace_hub.workspace_hub_config.default_workspace_resource_group
 
-    @default_workspace_resource_group.setter
-    def default_workspace_resource_group(self, value: str):
-        """Set the default_workspace_resource_group of the resource.
+    @default_project_resource_group.setter
+    def default_project_resource_group(self, value: str):
+        """Set the default_project_resource_group of the resource.
 
         :param value: The new type to assign to the resource.
         :type value: str

sdk/ai/azure-ai-resources/azure/ai/resources/entities/base_connection.py

@@ -31,6 +31,10 @@ class BaseConnection:
     :type tags: dict
     :param id: The connection's resource id.
     :type id: str
+    :param is_shared: For connections created for a project, this determines if the connection
+        is shared amongst other connections with that project's parent AI resource.
+        Defaults to true.
+    :type is_shared: bool
     """
 
     def __init__(
@@ -39,6 +43,7 @@ def __init__(
         target: str,
         type: str,  # pylint: disable=redefined-builtin
         credentials: ApiKeyConfiguration,
+        is_shared: bool=True,
         **kwargs,
     ):
         # Sneaky short-circuit to allow direct v2 WS conn injection without any
@@ -51,6 +56,7 @@ def __init__(
             target=target,
             type=type,
             credentials=credentials,
+            is_shared=is_shared,
             **kwargs,
         )
 
@@ -228,6 +234,26 @@ def metadata(self, value: Dict[str, Any]):
             return
         self._workspace_connection.tags = value
 
+    @property
+    def is_shared(self) -> bool:
+        """Get the Boolean describing if this connection is shared
+            amongst its cohort within a workspace hub. Only applicable for connections
+            that are project-scoped on creation.
+        :rtype: bool
+        """
+        return self._workspace_connection.is_shared
+
+    @is_shared.setter
+    def is_shared(self, value: bool):
+        """The is_shared determines if this connection is shared amongst other
+            lean workspaces within its parent workspace hub. Only applicable for connections
+            that are project-scoped on creation.
+        :type value: bool
+        """
+        if not value:
+            return
+        self._workspace_connection.is_shared = value
+
     def set_current_environment(self, credential: Optional[TokenCredential] = None):
         """Sets the current environment to use the connection. To use AAD auth for AzureOpenAI connetion, pass in a credential object.
         Only certain types of connections make use of this function. Those that don't will raise an error if this is called.

sdk/ai/azure-ai-resources/azure/ai/resources/entities/connection_subtypes.py

@@ -26,12 +26,16 @@ class AzureOpenAIConnection(BaseConnection):
     :type target: str
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
-    :param credentials: The credentials for authenticating to the external resource.
+    :param credentials: The credentials for authenticating the external resource.
     :type credentials: ~azure.ai.ml.entities.ApiKeyConfiguration
     :param api_version: The api version that this connection was created for.
     :type api_version: Optional[str]
     :param api_type: The api type that this connection was created for. Defaults to "Azure" and currently rarely changes.
     :type api_type: str
+    :param is_shared: For connections created for a project, this determines if the connection
+        is shared amongst other connections with that project's parent AI resource.
+        Defaults to true.
+    :type is_shared: bool
     """
 
     def __init__(
@@ -136,10 +140,14 @@ class AzureAISearchConnection(BaseConnection):
     :type target: str
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
-    :param credentials: The credentials for authenticating to the external resource.
+    :param credentials: The credentials for authenticating the external resource.
     :type credentials: ~azure.ai.ml.entities.ApiKeyConfiguration
     :param api_version: The api version that this connection was created for. Only applies to certain connection types.
     :type api_version: Optional[str]
+    :param is_shared: For connections created for a project, this determines if the connection
+        is shared amongst other connections with that project's parent AI resource.
+        Defaults to true.
+    :type is_shared: bool
     """
 
     def __init__(
@@ -195,21 +203,25 @@ def set_current_environment(self, credential: Optional[TokenCredential] = None):
 class AzureAIServiceConnection(BaseConnection):
     """A Connection for an Azure Cognitive Service. Note: This object usually shouldn't be created manually by users.
     To get the default AzureOpenAIConnection for an AI Resource, use an AIClient object to call the
-    'get_default_aoai_connection' function.
+    'get_default_content_safety_connection' function.
 
     :param name: Name of the connection.
     :type name: str
     :param target: The URL or ARM resource ID of the external resource.
     :type target: str
     :param tags: Tag dictionary. Tags can be added, removed, and updated.
     :type tags: dict
-    :param credentials: The credentials for authenticating to the external resource.
+    :param credentials: The credentials for authenticating the external resource.
     :type credentials: ~azure.ai.ml.entities.ApiKeyConfiguration
     :param api_version: The api version that this connection was created for.
     :type api_version: Optional[str]
     :param kind: The kind of ai service that this connection points to. Valid inputs include:
         "AzureOpenAI", "ContentSafety", and "Speech"
     :type kind: str
+    :param is_shared: For connections created for a project, this determines if the connection
+        is shared amongst other connections with that project's parent AI resource.
+        Defaults to true.
+    :type is_shared: bool
     """
 
     def __init__(
@@ -263,3 +275,56 @@ def kind(self, value: str) -> str:
         :rtype: str
         """
         self._workspace_connection.tags[CONNECTION_KIND_KEY] = value
+
+class GitHubConnection(BaseConnection):
+    """A Connection to GitHub.
+
+    :param name: Name of the connection.
+    :type name: str
+    :param target: The URL or ARM resource ID of the external resource.
+    :type target: str
+    :param tags: Tag dictionary. Tags can be added, removed, and updated.
+    :type tags: dict
+    :param credentials: The credentials for authenticating the external resource.
+    :type credentials: ~azure.ai.ml.entities.ApiKeyConfiguration
+    :param is_shared: For connections created for a project, this determines if the connection
+        is shared amongst other connections with that project's parent AI resource.
+        Defaults to true.
+    :type is_shared: bool
+    """
+
+    def __init__(
+        self,
+        *,
+        target: str,
+        credentials: ApiKeyConfiguration,
+        **kwargs,
+    ):
+        kwargs.pop("type", None)  # make sure we never somehow use wrong type
+        super().__init__(target=target, type="git", credentials=credentials, **kwargs)
+
+class CustomConnection(BaseConnection):
+    """A Connection to system that's not encapsulated by other connection types.
+
+    :param name: Name of the connection.
+    :type name: str
+    :param target: The URL or ARM resource ID of the external resource.
+    :type target: str
+    :param tags: Tag dictionary. Tags can be added, removed, and updated.
+    :type tags: dict
+    :param credentials: The credentials for authenticating the external resource.
+    :type credentials: ~azure.ai.ml.entities.ApiKeyConfiguration
+    :param is_shared: For connections created for a project, this determines if the connection
+        is shared amongst other connections with that project's parent AI resource.
+        Defaults to true.
+    :type is_shared: bool
+    """
+    def __init__(
+        self,
+        *,
+        target: str,
+        credentials: ApiKeyConfiguration,
+        **kwargs,
+    ):
+        kwargs.pop("type", None)  # make sure we never somehow use wrong type
+        super().__init__(target=target, type="custom", credentials=credentials, **kwargs)