DicomServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

HealthcareApisManagementClient's

<xref:dicom_services> attribute.

Inheritance

builtins.object

DicomServicesOperations

Constructor

DicomServicesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a DICOM Service resource with the specified parameters.
begin_delete	Deletes a DICOM Service.
begin_update	Patch DICOM Service details.
get	Gets the properties of the specified DICOM Service.
list_by_workspace	Lists all DICOM Services for the given workspace.

begin_create_or_update

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

async begin_create_or_update(resource_group_name: str, workspace_name: str, dicom_service_name: str, dicomservice: _models.DicomService, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DicomService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.
dicom_service_name Required	str The name of DICOM Service resource. Required.
dicomservice Required	DicomService or IO[bytes] The parameters for creating or updating a Dicom Service resource. Is either a DicomService type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[DicomService]	An instance of AsyncLROPoller that returns either DicomService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a DICOM Service.

async begin_delete(resource_group_name: str, dicom_service_name: str, workspace_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
dicom_service_name Required	str The name of DICOM Service resource. Required.
workspace_name Required	str The name of workspace resource. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Patch DICOM Service details.

async begin_update(resource_group_name: str, dicom_service_name: str, workspace_name: str, dicomservice_patch_resource: _models.DicomServicePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DicomService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
dicom_service_name Required	str The name of DICOM Service resource. Required.
workspace_name Required	str The name of workspace resource. Required.
dicomservice_patch_resource Required	DicomServicePatchResource or IO[bytes] The parameters for updating a Dicom Service. Is either a DicomServicePatchResource type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[DicomService]	An instance of AsyncLROPoller that returns either DicomService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the properties of the specified DICOM Service.

async get(resource_group_name: str, workspace_name: str, dicom_service_name: str, **kwargs: Any) -> DicomService

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.
dicom_service_name Required	str The name of DICOM Service resource. Required.

Returns

Type	Description
DicomService	DicomService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_workspace

Lists all DICOM Services for the given workspace.

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) -> AsyncIterable[DicomService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
workspace_name Required	str The name of workspace resource. Required.

Returns

Type	Description
AsyncItemPaged[DicomService]	An iterator like instance of either DicomService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.healthcareapis.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\healthcareapis\\models\\__init__.py'>