azure-mgmt-healthcareapis 3.0.0b1

Microsoft Azure Healthcareapis Management Client Library for Python

Microsoft Azure SDK for Python

This is the Microsoft Azure Health Care Apis Management Client Library. This package has been tested with Python 3.10+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

• Python 3.10+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-healthcareapis
pip install azure-identity

Authentication

By default, Microsoft Entra token authentication depends on correct configuration of the following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, client can be authenticated by following code:

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = HealthcareApisManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

• Search Health Care Apis Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

3.0.0b1 (2026-06-03)

Features Added

• Client HealthcareApisManagementClient added parameter cloud_setting in method __init__
• Client HealthcareApisManagementClient added method send_request
• Model PrivateEndpointConnection added property system_data
• Model PrivateLinkResourceListResultDescription added property next_link
• Model Resource added property system_data
• Model StorageConfiguration added property storage_indexing_configuration
• Added model ProxyResource
• Added model StorageIndexingConfiguration
• Added model TrackedResource

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• Model IotFhirDestination moved instance variable provisioning_state, resource_identity_resolution_type, fhir_service_resource_id and fhir_mapping under property properties whose type is IotFhirDestinationProperties
• Model PrivateEndpointConnectionDescription moved instance variable private_endpoint, private_link_service_connection_state and provisioning_state under property properties whose type is PrivateEndpointConnectionProperties
• Model PrivateLinkResourceDescription moved instance variable group_id, required_members and required_zone_names under property properties whose type is PrivateLinkResourceProperties
• Model ServicesPatchDescription moved instance variable public_network_access under property properties whose type is ServicesPropertiesUpdateParameters

Other Changes

• Deleted model DicomServiceCollection/FhirServiceCollection/IotConnectorCollection/IotFhirDestinationCollection/ListOperations/PrivateEndpointConnectionListResultDescription/WorkspaceList which actually were not used by SDK users
• Deleted model LocationBasedResource/PrivateLinkResource/ResourceCore/ServiceManagedIdentity/ServicesResource/TaggedResource which actually were not used by SDK users

2.1.0 (2024-04-22)

Features Added

• Model DicomService has a new parameter enable_data_partitions
• Model DicomService has a new parameter storage_configuration
• Model FhirServiceAuthenticationConfiguration has a new parameter smart_identity_providers

2.0.0 (2023-12-18)

Features Added

• Model DicomService has a new parameter cors_configuration
• Model DicomService has a new parameter encryption
• Model DicomService has a new parameter event_state
• Model FhirService has a new parameter encryption
• Model FhirService has a new parameter implementation_guides_configuration
• Model FhirService has a new parameter import_configuration
• Model MetricSpecification has a new parameter enable_regional_mdm_account
• Model MetricSpecification has a new parameter is_internal
• Model MetricSpecification has a new parameter metric_filter_pattern
• Model MetricSpecification has a new parameter resource_id_dimension_name_override
• Model MetricSpecification has a new parameter source_mdm_account
• Model ServiceCosmosDbConfigurationInfo has a new parameter cross_tenant_cmk_application_id
• Model ServicesProperties has a new parameter import_configuration

Breaking Changes

• Model FhirService no longer has parameter access_policies

1.2.0b1 (2022-11-22)

Features Added

• Model DicomService has a new parameter cors_configuration
• Model FhirService has a new parameter import_configuration
• Model MetricSpecification has a new parameter enable_regional_mdm_account
• Model MetricSpecification has a new parameter is_internal
• Model MetricSpecification has a new parameter metric_filter_pattern
• Model MetricSpecification has a new parameter resource_id_dimension_name_override
• Model MetricSpecification has a new parameter source_mdm_account
• Model ServicesProperties has a new parameter import_configuration

1.1.0 (2022-03-31)

Features

• Added operation group WorkspacePrivateEndpointConnectionsOperations
• Added operation group WorkspacePrivateLinkResourcesOperations
• Model DicomService has a new parameter identity
• Model DicomService has a new parameter private_endpoint_connections
• Model DicomService has a new parameter public_network_access
• Model DicomServicePatchResource has a new parameter identity
• Model FhirService has a new parameter event_state
• Model FhirService has a new parameter private_endpoint_connections
• Model FhirService has a new parameter public_network_access
• Model FhirService has a new parameter resource_version_policy_configuration
• Model FhirServiceAcrConfiguration has a new parameter oci_artifacts
• Model OperationDetail has a new parameter properties
• Model OperationResultsDescription has a new parameter end_time
• Model ServiceAcrConfigurationInfo has a new parameter oci_artifacts
• Model ServiceManagedIdentityIdentity has a new parameter principal_id
• Model ServiceManagedIdentityIdentity has a new parameter tenant_id
• Model ServiceManagedIdentityIdentity has a new parameter user_assigned_identities
• Model WorkspaceProperties has a new parameter private_endpoint_connections
• Model WorkspaceProperties has a new parameter public_network_access

Breaking changes

• Parameter type of model ServiceManagedIdentityIdentity is now required

1.1.0b1 (2021-08-26)

Features

• Added operation group IotConnectorFhirDestinationOperations
• Added operation group WorkspacesOperations
• Added operation group FhirDestinationsOperations
• Added operation group DicomServicesOperations
• Added operation group FhirServicesOperations
• Added operation group IotConnectorsOperations

1.0.0 (2021-04-12)

Features

• Model ServicesDescription has a new parameter system_data
• Model ServicesProperties has a new parameter acr_configuration

1.0.0b1 (2020-12-04)

This is beta preview version.

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

General breaking changes

• Credential system has been completly revamped:

  • azure.common.credentials or msrestazure.azure_active_directory instances are no longer supported, use the azure-identity classes instead: https://pypi.org/project/azure-identity/
  • credentials parameter has been renamed credential

• The config attribute no longer exists on a client, configuration should be passed as kwarg. Example: MyClient(credential, subscription_id, enable_logging=True). For a complete set of supported options, see the parameters accept in init documentation of azure-core

• You can't import a version module anymore, use __version__ instead

• Operations that used to return a msrest.polling.LROPoller now returns a azure.core.polling.LROPoller and are prefixed with begin_.

• Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError (CloudError has been removed).

• Most of the operation kwarg have changed. Some of the most noticeable:

  • raw has been removed. Equivalent feature can be found using cls, a callback that will give access to internal HTTP response for advanced user
  • For a complete set of supported options, see the parameters accept in Request documentation of azure-core

General new features

• Type annotations support using typing. SDKs are mypy ready.
• This client has now stable and official support for async. Check the aio namespace of your package to find the async client.
• This client now support natively tracing library like OpenCensus or OpenTelemetry. See this tracing quickstart for an overview.

0.2.0 (2020-11-02)

Features

• Model ServiceCosmosDbConfigurationInfo has a new parameter key_vault_key_uri
• Model ServicesPatchDescription has a new parameter public_network_access
• Model ServicesDescription has a new parameter identity
• Model ServicesProperties has a new parameter public_network_access
• Model ServicesProperties has a new parameter export_configuration
• Model ServicesProperties has a new parameter private_endpoint_connections
• Added operation group PrivateEndpointConnectionsOperations
• Added operation group PrivateLinkResourcesOperations

Breaking changes

• Operation ServicesOperations.update has a new signature
• Model Resource no longer has parameter kind
• Model Resource no longer has parameter tags
• Model Resource no longer has parameter etag
• Model Resource no longer has parameter location

0.1.0 (2019-08-03)

• Initial Release