Interface WorkspaceConnections


  • public interface WorkspaceConnections
    Resource collection API of WorkspaceConnections.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<WorkspaceConnection> list​(String resourceGroupName,
                                                                         String workspaceName)
        List all connections under a AML workspace.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        Returns:
        paginated list of Workspace connection objects as paginated response with PagedIterable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • list

        com.azure.core.http.rest.PagedIterable<WorkspaceConnection> list​(String resourceGroupName,
                                                                         String workspaceName,
                                                                         String target,
                                                                         String category,
                                                                         com.azure.core.util.Context context)
        List all connections under a AML workspace.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        target - Target of the workspace connection.
        category - Category of the workspace connection.
        context - The context to associate with this operation.
        Returns:
        paginated list of Workspace connection objects as paginated response with PagedIterable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • get

        WorkspaceConnection get​(String resourceGroupName,
                                String workspaceName,
                                String connectionName)
        Get the detail of a workspace connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        connectionName - Friendly name of the workspace connection.
        Returns:
        the detail of a workspace connection.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponse

        com.azure.core.http.rest.Response<WorkspaceConnection> getWithResponse​(String resourceGroupName,
                                                                               String workspaceName,
                                                                               String connectionName,
                                                                               com.azure.core.util.Context context)
        Get the detail of a workspace connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        connectionName - Friendly name of the workspace connection.
        context - The context to associate with this operation.
        Returns:
        the detail of a workspace connection along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • delete

        void delete​(String resourceGroupName,
                    String workspaceName,
                    String connectionName)
        Delete a workspace connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        connectionName - Friendly name of the workspace connection.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String workspaceName,
                                                                   String connectionName,
                                                                   com.azure.core.util.Context context)
        Delete a workspace connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        connectionName - Friendly name of the workspace connection.
        context - The context to associate with this operation.
        Returns:
        the Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getById

        WorkspaceConnection getById​(String id)
        Get the detail of a workspace connection.
        Parameters:
        id - the resource ID.
        Returns:
        the detail of a workspace connection along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<WorkspaceConnection> getByIdWithResponse​(String id,
                                                                                   com.azure.core.util.Context context)
        Get the detail of a workspace connection.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the detail of a workspace connection along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteById

        void deleteById​(String id)
        Delete a workspace connection.
        Parameters:
        id - the resource ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Delete a workspace connection.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.