Interface DicomServicesClient


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

      • listByWorkspace

        com.azure.core.http.rest.PagedIterable<DicomServiceInner> listByWorkspace​(String resourceGroupName,
                                                                                  String workspaceName)
        Lists all DICOM Services for the given workspace.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        Returns:
        the collection of Dicom Services 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<DicomServiceInner> listByWorkspace​(String resourceGroupName,
                                                                                  String workspaceName,
                                                                                  com.azure.core.util.Context context)
        Lists all DICOM Services 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:
        the collection of Dicom Services 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

        DicomServiceInner get​(String resourceGroupName,
                              String workspaceName,
                              String dicomServiceName)
        Gets the properties of the specified DICOM Service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        dicomServiceName - The name of DICOM Service resource.
        Returns:
        the properties of the specified DICOM Service.
        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<DicomServiceInner> getWithResponse​(String resourceGroupName,
                                                                             String workspaceName,
                                                                             String dicomServiceName,
                                                                             com.azure.core.util.Context context)
        Gets the properties of the specified DICOM Service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        dicomServiceName - The name of DICOM Service resource.
        context - The context to associate with this operation.
        Returns:
        the properties of the specified DICOM Service 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<DicomServiceInner>,​DicomServiceInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String workspaceName,
                                                                                                                                                            String dicomServiceName,
                                                                                                                                                            DicomServiceInner dicomservice)
        Creates or updates a DICOM Service resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        dicomServiceName - The name of DICOM Service resource.
        dicomservice - The parameters for creating or updating a Dicom Service resource.
        Returns:
        the SyncPoller for polling of the description of Dicom Service.
        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<DicomServiceInner>,​DicomServiceInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String workspaceName,
                                                                                                                                                            String dicomServiceName,
                                                                                                                                                            DicomServiceInner dicomservice,
                                                                                                                                                            com.azure.core.util.Context context)
        Creates or updates a DICOM Service resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        dicomServiceName - The name of DICOM Service resource.
        dicomservice - The parameters for creating or updating a Dicom Service resource.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of the description of Dicom Service.
        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

        DicomServiceInner createOrUpdate​(String resourceGroupName,
                                         String workspaceName,
                                         String dicomServiceName,
                                         DicomServiceInner dicomservice)
        Creates or updates a DICOM Service resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        dicomServiceName - The name of DICOM Service resource.
        dicomservice - The parameters for creating or updating a Dicom Service resource.
        Returns:
        the description of Dicom Service.
        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

        DicomServiceInner createOrUpdate​(String resourceGroupName,
                                         String workspaceName,
                                         String dicomServiceName,
                                         DicomServiceInner dicomservice,
                                         com.azure.core.util.Context context)
        Creates or updates a DICOM Service resource with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        workspaceName - The name of workspace resource.
        dicomServiceName - The name of DICOM Service resource.
        dicomservice - The parameters for creating or updating a Dicom Service resource.
        context - The context to associate with this operation.
        Returns:
        the description of Dicom Service.
        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<DicomServiceInner>,​DicomServiceInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                    String dicomServiceName,
                                                                                                                                                    String workspaceName,
                                                                                                                                                    DicomServicePatchResource dicomservicePatchResource)
        Patch DICOM Service details.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service resource.
        workspaceName - The name of workspace resource.
        dicomservicePatchResource - The parameters for updating a Dicom Service.
        Returns:
        the SyncPoller for polling of the description of Dicom Service.
        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<DicomServiceInner>,​DicomServiceInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                    String dicomServiceName,
                                                                                                                                                    String workspaceName,
                                                                                                                                                    DicomServicePatchResource dicomservicePatchResource,
                                                                                                                                                    com.azure.core.util.Context context)
        Patch DICOM Service details.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service resource.
        workspaceName - The name of workspace resource.
        dicomservicePatchResource - The parameters for updating a Dicom Service.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of the description of Dicom Service.
        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

        DicomServiceInner update​(String resourceGroupName,
                                 String dicomServiceName,
                                 String workspaceName,
                                 DicomServicePatchResource dicomservicePatchResource)
        Patch DICOM Service details.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service resource.
        workspaceName - The name of workspace resource.
        dicomservicePatchResource - The parameters for updating a Dicom Service.
        Returns:
        the description of Dicom Service.
        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

        DicomServiceInner update​(String resourceGroupName,
                                 String dicomServiceName,
                                 String workspaceName,
                                 DicomServicePatchResource dicomservicePatchResource,
                                 com.azure.core.util.Context context)
        Patch DICOM Service details.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service resource.
        workspaceName - The name of workspace resource.
        dicomservicePatchResource - The parameters for updating a Dicom Service.
        context - The context to associate with this operation.
        Returns:
        the description of Dicom Service.
        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 dicomServiceName,
                                                                                                                          String workspaceName)
        Deletes a DICOM Service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service 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 dicomServiceName,
                                                                                                                          String workspaceName,
                                                                                                                          com.azure.core.util.Context context)
        Deletes a DICOM Service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service 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 dicomServiceName,
                    String workspaceName)
        Deletes a DICOM Service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service 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 dicomServiceName,
                    String workspaceName,
                    com.azure.core.util.Context context)
        Deletes a DICOM Service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        dicomServiceName - The name of DICOM Service 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.