FhirServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

HealthcareApisManagementClient's

<xref:fhir_services> attribute.

Inheritance

builtins.object

FhirServicesOperations

Constructor

FhirServicesOperations(*args, **kwargs)

Methods

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

begin_create_or_update

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

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

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.
fhir_service_name Required	str The name of FHIR Service resource. Required.
fhirservice Required	FhirService or IO[bytes] The parameters for creating or updating a Fhir Service resource. Is either a FhirService type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a FHIR Service.

async begin_delete(resource_group_name: str, fhir_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.
fhir_service_name Required	str The name of FHIR 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 FHIR Service details.

async begin_update(resource_group_name: str, fhir_service_name: str, workspace_name: str, fhirservice_patch_resource: _models.FhirServicePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.FhirService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
fhir_service_name Required	str The name of FHIR Service resource. Required.
workspace_name Required	str The name of workspace resource. Required.
fhirservice_patch_resource Required	FhirServicePatchResource or IO[bytes] The parameters for updating a Fhir Service. Is either a FhirServicePatchResource type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets the properties of the specified FHIR Service.

async get(resource_group_name: str, workspace_name: str, fhir_service_name: str, **kwargs: Any) -> FhirService

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.
fhir_service_name Required	str The name of FHIR Service resource. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_workspace

Lists all FHIR Services for the given workspace.

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

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[FhirService]	An iterator like instance of either FhirService 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'>