Interface IotConnectors


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

      • listByWorkspace

        com.azure.core.http.rest.PagedIterable<IotConnector> 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<IotConnector> 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

        IotConnector 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<IotConnector> 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.
      • 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.
      • getById

        IotConnector getById​(String id)
        Gets the properties of the specified IoT Connector.
        Parameters:
        id - the resource ID.
        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.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<IotConnector> getByIdWithResponse​(String id,
                                                                            com.azure.core.util.Context context)
        Gets the properties of the specified IoT Connector.
        Parameters:
        id - the resource ID.
        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.
      • deleteById

        void deleteById​(String id)
        Deletes an IoT Connector.
        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

        void deleteByIdWithResponse​(String id,
                                    com.azure.core.util.Context context)
        Deletes an IoT Connector.
        Parameters:
        id - the resource ID.
        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.
      • define

        IotConnector.DefinitionStages.Blank define​(String name)
        Begins definition for a new IotConnector resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new IotConnector definition.