Interface DataConnectors


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

      • list

        com.azure.core.http.rest.PagedIterable<DataConnector> list​(String resourceGroupName,
                                                                   String workspaceName)
        Gets all data connectors.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        Returns:
        all data connectors 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<DataConnector> list​(String resourceGroupName,
                                                                   String workspaceName,
                                                                   com.azure.core.util.Context context)
        Gets all data connectors.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        context - The context to associate with this operation.
        Returns:
        all data connectors 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

        DataConnector get​(String resourceGroupName,
                          String workspaceName,
                          String dataConnectorId)
        Gets a data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector ID.
        Returns:
        a data connector.
        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<DataConnector> getWithResponse​(String resourceGroupName,
                                                                         String workspaceName,
                                                                         String dataConnectorId,
                                                                         com.azure.core.util.Context context)
        Gets a data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector ID.
        context - The context to associate with this operation.
        Returns:
        a data connector 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.
      • createOrUpdate

        DataConnector createOrUpdate​(String resourceGroupName,
                                     String workspaceName,
                                     String dataConnectorId,
                                     DataConnectorInner dataConnector)
        Creates or updates the data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector ID.
        dataConnector - The data connector.
        Returns:
        data connector.
        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.
      • createOrUpdateWithResponse

        com.azure.core.http.rest.Response<DataConnector> createOrUpdateWithResponse​(String resourceGroupName,
                                                                                    String workspaceName,
                                                                                    String dataConnectorId,
                                                                                    DataConnectorInner dataConnector,
                                                                                    com.azure.core.util.Context context)
        Creates or updates the data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector ID.
        dataConnector - The data connector.
        context - The context to associate with this operation.
        Returns:
        data connector 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 dataConnectorId)
        Delete the data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector 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.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String workspaceName,
                                                                   String dataConnectorId,
                                                                   com.azure.core.util.Context context)
        Delete the data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector 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.
      • connect

        void connect​(String resourceGroupName,
                     String workspaceName,
                     String dataConnectorId,
                     DataConnectorConnectBody connectBody)
        Connects a data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector ID.
        connectBody - The data connector.
        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.
      • connectWithResponse

        com.azure.core.http.rest.Response<Void> connectWithResponse​(String resourceGroupName,
                                                                    String workspaceName,
                                                                    String dataConnectorId,
                                                                    DataConnectorConnectBody connectBody,
                                                                    com.azure.core.util.Context context)
        Connects a data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector ID.
        connectBody - The data connector.
        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.
      • disconnect

        void disconnect​(String resourceGroupName,
                        String workspaceName,
                        String dataConnectorId)
        Disconnect a data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector 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.
      • disconnectWithResponse

        com.azure.core.http.rest.Response<Void> disconnectWithResponse​(String resourceGroupName,
                                                                       String workspaceName,
                                                                       String dataConnectorId,
                                                                       com.azure.core.util.Context context)
        Disconnect a data connector.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        dataConnectorId - Connector 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.