DicomServicesOperations Class

DicomServicesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DicomServicesOperations

Constructor

DicomServicesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

begin_create_or_update(resource_group_name: str, workspace_name: str, dicom_service_name: str, dicomservice: azure.mgmt.healthcareapis.models._models_py3.DicomService, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.healthcareapis.models._models_py3.DicomService]

Parameters

resource_group_name

str

Required

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

workspace_name

str

Required

The name of workspace resource.

dicom_service_name

str

Required

The name of DICOM Service resource.

dicomservice

DicomService

Required

The parameters for creating or updating a Dicom Service resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DicomService or the result of cls(response)

Return type

LROPoller[DicomService]

Exceptions

HttpResponseError

begin_delete

Deletes a DICOM Service.

begin_delete(resource_group_name: str, dicom_service_name: str, workspace_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

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

dicom_service_name

str

Required

The name of DICOM Service resource.

workspace_name

str

Required

The name of workspace resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Patch DICOM Service details.

begin_update(resource_group_name: str, dicom_service_name: str, workspace_name: str, dicomservice_patch_resource: azure.mgmt.healthcareapis.models._models_py3.DicomServicePatchResource, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.healthcareapis.models._models_py3.DicomService]

Parameters

resource_group_name

str

Required

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

dicom_service_name

str

Required

The name of DICOM Service resource.

workspace_name

str

Required

The name of workspace resource.

dicomservice_patch_resource

DicomServicePatchResource

Required

The parameters for updating a Dicom Service.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DicomService or the result of cls(response)

Return type

LROPoller[DicomService]

Exceptions

HttpResponseError

get

Gets the properties of the specified DICOM Service.

get(resource_group_name: str, workspace_name: str, dicom_service_name: str, **kwargs: Any) -> azure.mgmt.healthcareapis.models._models_py3.DicomService

Parameters

resource_group_name

str

Required

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

workspace_name

str

Required

The name of workspace resource.

dicom_service_name

str

Required

The name of DICOM Service resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

DicomService, or the result of cls(response)

Return type

DicomService

Exceptions

HttpResponseError

list_by_workspace

Lists all DICOM Services for the given workspace.

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) -> Iterable[azure.mgmt.healthcareapis.models._models_py3.DicomServiceCollection]

Parameters

resource_group_name

str

Required

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

workspace_name

str

Required

The name of workspace resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DicomServiceCollection or the result of cls(response)

Return type

ItemPaged[DicomServiceCollection]

Exceptions

HttpResponseError

Attributes

models

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