DicomServices interface

Interface representing a DicomServices.

Methods

beginCreateOrUpdate(string, string, string, DicomService, DicomServicesCreateOrUpdateOptionalParams)

Creates or updates a DICOM Service resource with the specified parameters.

beginCreateOrUpdateAndWait(string, string, string, DicomService, DicomServicesCreateOrUpdateOptionalParams)

Creates or updates a DICOM Service resource with the specified parameters.

beginDelete(string, string, string, DicomServicesDeleteOptionalParams)

Deletes a DICOM Service.

beginDeleteAndWait(string, string, string, DicomServicesDeleteOptionalParams)

Deletes a DICOM Service.

beginUpdate(string, string, string, DicomServicePatchResource, DicomServicesUpdateOptionalParams)

Patch DICOM Service details.

beginUpdateAndWait(string, string, string, DicomServicePatchResource, DicomServicesUpdateOptionalParams)

Patch DICOM Service details.

get(string, string, string, DicomServicesGetOptionalParams)

Gets the properties of the specified DICOM Service.

listByWorkspace(string, string, DicomServicesListByWorkspaceOptionalParams)

Lists all DICOM Services for the given workspace

Method Details

beginCreateOrUpdate(string, string, string, DicomService, DicomServicesCreateOrUpdateOptionalParams)

Creates or updates a DICOM Service resource with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, dicomServiceName: string, dicomservice: DicomService, options?: DicomServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DicomService>, DicomService>>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

workspaceName

string

The name of workspace resource.

dicomServiceName

string

The name of DICOM Service resource.

dicomservice
DicomService

The parameters for creating or updating a Dicom Service resource.

options
DicomServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DicomService>, DicomService>>

beginCreateOrUpdateAndWait(string, string, string, DicomService, DicomServicesCreateOrUpdateOptionalParams)

Creates or updates a DICOM Service resource with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, dicomServiceName: string, dicomservice: DicomService, options?: DicomServicesCreateOrUpdateOptionalParams): Promise<DicomService>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

workspaceName

string

The name of workspace resource.

dicomServiceName

string

The name of DICOM Service resource.

dicomservice
DicomService

The parameters for creating or updating a Dicom Service resource.

options
DicomServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DicomService>

beginDelete(string, string, string, DicomServicesDeleteOptionalParams)

Deletes a DICOM Service.

function beginDelete(resourceGroupName: string, dicomServiceName: string, workspaceName: string, options?: DicomServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

dicomServiceName

string

The name of DICOM Service resource.

workspaceName

string

The name of workspace resource.

options
DicomServicesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, DicomServicesDeleteOptionalParams)

Deletes a DICOM Service.

function beginDeleteAndWait(resourceGroupName: string, dicomServiceName: string, workspaceName: string, options?: DicomServicesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

dicomServiceName

string

The name of DICOM Service resource.

workspaceName

string

The name of workspace resource.

options
DicomServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, DicomServicePatchResource, DicomServicesUpdateOptionalParams)

Patch DICOM Service details.

function beginUpdate(resourceGroupName: string, dicomServiceName: string, workspaceName: string, dicomservicePatchResource: DicomServicePatchResource, options?: DicomServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DicomService>, DicomService>>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

dicomServiceName

string

The name of DICOM Service resource.

workspaceName

string

The name of workspace resource.

dicomservicePatchResource
DicomServicePatchResource

The parameters for updating a Dicom Service.

options
DicomServicesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DicomService>, DicomService>>

beginUpdateAndWait(string, string, string, DicomServicePatchResource, DicomServicesUpdateOptionalParams)

Patch DICOM Service details.

function beginUpdateAndWait(resourceGroupName: string, dicomServiceName: string, workspaceName: string, dicomservicePatchResource: DicomServicePatchResource, options?: DicomServicesUpdateOptionalParams): Promise<DicomService>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

dicomServiceName

string

The name of DICOM Service resource.

workspaceName

string

The name of workspace resource.

dicomservicePatchResource
DicomServicePatchResource

The parameters for updating a Dicom Service.

options
DicomServicesUpdateOptionalParams

The options parameters.

Returns

Promise<DicomService>

get(string, string, string, DicomServicesGetOptionalParams)

Gets the properties of the specified DICOM Service.

function get(resourceGroupName: string, workspaceName: string, dicomServiceName: string, options?: DicomServicesGetOptionalParams): Promise<DicomService>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

workspaceName

string

The name of workspace resource.

dicomServiceName

string

The name of DICOM Service resource.

options
DicomServicesGetOptionalParams

The options parameters.

Returns

Promise<DicomService>

listByWorkspace(string, string, DicomServicesListByWorkspaceOptionalParams)

Lists all DICOM Services for the given workspace

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: DicomServicesListByWorkspaceOptionalParams): PagedAsyncIterableIterator<DicomService, DicomService[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

workspaceName

string

The name of workspace resource.

options
DicomServicesListByWorkspaceOptionalParams

The options parameters.

Returns