Package com.azure.resourcemanager.healthcareapis.models

Interface DicomServices

public interface DicomServices

Resource collection API of DicomServices.

Method Summary

Modifier and Type	Method	Description
DicomService.DefinitionStages.Blank	define(String name)	Begins definition for a new DicomService resource.
void	delete(String resourceGroupName, String dicomServiceName, String workspaceName)	Deletes a DICOM Service.
void	delete(String resourceGroupName, String dicomServiceName, String workspaceName, com.azure.core.util.Context context)	Deletes a DICOM Service.
void	deleteById(String id)	Deletes a DICOM Service.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a DICOM Service.
DicomService	get(String resourceGroupName, String workspaceName, String dicomServiceName)	Gets the properties of the specified DICOM Service.
DicomService	getById(String id)	Gets the properties of the specified DICOM Service.
com.azure.core.http.rest.Response<DicomService>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the properties of the specified DICOM Service.
com.azure.core.http.rest.Response<DicomService>	getWithResponse(String resourceGroupName, String workspaceName, String dicomServiceName, com.azure.core.util.Context context)	Gets the properties of the specified DICOM Service.
com.azure.core.http.rest.PagedIterable<DicomService>	listByWorkspace(String resourceGroupName, String workspaceName)	Lists all DICOM Services for the given workspace.
com.azure.core.http.rest.PagedIterable<DicomService>	listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Lists all DICOM Services for the given workspace.

Method Detail

listByWorkspace

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

DicomService 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<DicomService> 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.

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.

getById

DicomService getById(String id)

Gets the properties of the specified DICOM Service.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<DicomService> getByIdWithResponse(String id,
                                                                    com.azure.core.util.Context context)

Gets the properties of the specified DICOM Service.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes a DICOM Service.

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 a DICOM Service.

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

DicomService.DefinitionStages.Blank define(String name)

Begins definition for a new DicomService resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DicomService definition.