Interface IotConnectorsClient


  • public interface IotConnectorsClient
    An instance of this class provides access to all the operations defined in IotConnectorsClient.
    • Method Detail

      • listByWorkspace

        com.azure.core.http.rest.PagedIterable<IotConnectorInner> listByWorkspace​(String resourceGroupName,
                                                                                  String workspaceName)
        Lists all IoT Connectors for the given workspace.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        Returns:
        a collection of IoT 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.
      • listByWorkspace

        com.azure.core.http.rest.PagedIterable<IotConnectorInner> listByWorkspace​(String resourceGroupName,
                                                                                  String workspaceName,
                                                                                  com.azure.core.util.Context context)
        Lists all IoT Connectors for the given workspace.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        context - The context to associate with this operation.
        Returns:
        a collection of IoT 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

        IotConnectorInner get​(String resourceGroupName,
                              String workspaceName,
                              String iotConnectorName)
        Gets the properties of the specified IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        iotConnectorName - The name of IoT Connector resource.
        Returns:
        the properties of the specified IoT 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<IotConnectorInner> getWithResponse​(String resourceGroupName,
                                                                             String workspaceName,
                                                                             String iotConnectorName,
                                                                             com.azure.core.util.Context context)
        Gets the properties of the specified IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        iotConnectorName - The name of IoT Connector resource.
        context - The context to associate with this operation.
        Returns:
        the properties of the specified IoT 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotConnectorInner>,​IotConnectorInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String workspaceName,
                                                                                                                                                            String iotConnectorName,
                                                                                                                                                            IotConnectorInner iotConnector)
        Creates or updates an IoT Connector resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        iotConnectorName - The name of IoT Connector resource.
        iotConnector - The parameters for creating or updating an IoT Connectors resource.
        Returns:
        the SyncPoller for polling of ioT Connector definition.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotConnectorInner>,​IotConnectorInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String workspaceName,
                                                                                                                                                            String iotConnectorName,
                                                                                                                                                            IotConnectorInner iotConnector,
                                                                                                                                                            com.azure.core.util.Context context)
        Creates or updates an IoT Connector resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        iotConnectorName - The name of IoT Connector resource.
        iotConnector - The parameters for creating or updating an IoT Connectors resource.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of ioT Connector definition.
        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

        IotConnectorInner createOrUpdate​(String resourceGroupName,
                                         String workspaceName,
                                         String iotConnectorName,
                                         IotConnectorInner iotConnector)
        Creates or updates an IoT Connector resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        iotConnectorName - The name of IoT Connector resource.
        iotConnector - The parameters for creating or updating an IoT Connectors resource.
        Returns:
        ioT Connector definition.
        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

        IotConnectorInner createOrUpdate​(String resourceGroupName,
                                         String workspaceName,
                                         String iotConnectorName,
                                         IotConnectorInner iotConnector,
                                         com.azure.core.util.Context context)
        Creates or updates an IoT Connector resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        iotConnectorName - The name of IoT Connector resource.
        iotConnector - The parameters for creating or updating an IoT Connectors resource.
        context - The context to associate with this operation.
        Returns:
        ioT Connector definition.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotConnectorInner>,​IotConnectorInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                    String iotConnectorName,
                                                                                                                                                    String workspaceName,
                                                                                                                                                    IotConnectorPatchResource iotConnectorPatchResource)
        Patch an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        iotConnectorPatchResource - The parameters for updating an IoT Connector.
        Returns:
        the SyncPoller for polling of ioT Connector definition.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotConnectorInner>,​IotConnectorInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                    String iotConnectorName,
                                                                                                                                                    String workspaceName,
                                                                                                                                                    IotConnectorPatchResource iotConnectorPatchResource,
                                                                                                                                                    com.azure.core.util.Context context)
        Patch an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        iotConnectorPatchResource - The parameters for updating an IoT Connector.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of ioT Connector definition.
        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.
      • update

        IotConnectorInner update​(String resourceGroupName,
                                 String iotConnectorName,
                                 String workspaceName,
                                 IotConnectorPatchResource iotConnectorPatchResource)
        Patch an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        iotConnectorPatchResource - The parameters for updating an IoT Connector.
        Returns:
        ioT Connector definition.
        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.
      • update

        IotConnectorInner update​(String resourceGroupName,
                                 String iotConnectorName,
                                 String workspaceName,
                                 IotConnectorPatchResource iotConnectorPatchResource,
                                 com.azure.core.util.Context context)
        Patch an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        iotConnectorPatchResource - The parameters for updating an IoT Connector.
        context - The context to associate with this operation.
        Returns:
        ioT Connector definition.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String iotConnectorName,
                                                                                                                          String workspaceName)
        Deletes an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        Returns:
        the SyncPoller for polling of long-running operation.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String iotConnectorName,
                                                                                                                          String workspaceName,
                                                                                                                          com.azure.core.util.Context context)
        Deletes an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running operation.
        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 iotConnectorName,
                    String workspaceName)
        Deletes an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        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 iotConnectorName,
                    String workspaceName,
                    com.azure.core.util.Context context)
        Deletes an IoT Connector.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        iotConnectorName - The name of IoT Connector resource.
        workspaceName - The name of workspace resource.
        context - The context to associate with this operation.
        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.