Microsoft Azure SDK for Python

This is the Microsoft Azure Horizondb 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-horizondb
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.horizondb import HorizonDBMgmtClient
import os

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

Examples

Code samples for this package can be found at:

• Search Horizondb 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

1.0.0b3 (2026-10-15)

Features Added

• Model ParameterProperties added property default_value
• Model ParameterProperties added property value_source
• Added model ActivateChangeDataCaptureIdentityRequest
• Added model ActivateChangeDataCaptureIdentityResult
• Added enum AiModelManagementStatus
• Added model Authentication
• Added enum AuthenticationName
• Added model AuthenticationProperties
• Added model BackupProperties
• Added model BackupPropertiesForPatchUpdate
• Added model Capability
• Added model CapabilityProperties
• Added model ChangeDataCaptureCapability
• Added model ChangeDataCaptureCapabilityForPatchUpdate
• Added model ChangeDataCaptureCapabilityProperties
• Added model ChangeDataCaptureCapabilityPropertiesForPatchUpdate
• Added model ChangeDataCaptureConfiguration
• Added model ChangeDataCaptureConfigurationForPatchUpdate
• Added model ChangeDataCaptureConfigurationProperties
• Added model ChangeDataCaptureConfigurationPropertiesForPatchUpdate
• Added enum ChangeDataCaptureDesiredState
• Added model ChangeDataCaptureDestination
• Added model ChangeDataCaptureDestinationDetails
• Added enum ChangeDataCaptureDestinationEffectiveState
• Added model ChangeDataCaptureDestinationForPatchUpdate
• Added model ChangeDataCaptureDestinationProperties
• Added model ChangeDataCaptureDestinationPropertiesForPatchUpdate
• Added enum ChangeDataCaptureDestinationType
• Added enum ChangeDataCaptureEffectiveState
• Added enum ChangeDataCaptureEngineConfigurationState
• Added enum ChangeDataCaptureExtensionState
• Added model ChangeDataCaptureExtensionStatus
• Added enum ChangeDataCaptureIdentityActivationState
• Added model ChangeDataCaptureIdentityAssignmentProperties
• Added enum ChangeDataCaptureIdentityAssignmentState
• Added enum ChangeDataCaptureIdentityValidationState
• Added model ChangeDataCapturePrerequisiteStatus
• Added enum ChangeDataCaptureProtocol
• Added enum ChangeDataCaptureReadWriteEndpointState
• Added enum ChangeDataCaptureReplicationArchitecture
• Added enum ChangeDataCaptureReplicationState
• Added model ChangeDataCaptureReplicationStatus
• Added model ChangeDataCaptureStatus
• Added enum ChangeDataCaptureTopologyBindingState
• Added model ChangeDataCaptureTopologyBindingStatus
• Added enum ChangeDataCaptureUsageProfile
• Added model Cluster
• Added model ClusterCapability
• Added enum ClusterCreateMode
• Added model ClusterFeatureCapability
• Added model ClusterForPatchUpdate
• Added model ClusterProperties
• Added model ClusterPropertiesForPatchUpdate
• Added enum ClusterState
• Added model ComputeGenerationCapability
• Added model ComputeModelCapability
• Added model ComputeProcessorCapability
• Added enum ComputeProcessorType
• Added model ComputeSizeCapability
• Added model DefaultParameterGroup
• Added model DefaultParameterGroupProperties
• Added model Endpoint
• Added model EndpointProperties
• Added enum EndpointRole
• Added enum EndpointScope
• Added model FabricDestinationDetails
• Added model FirewallRule
• Added model FirewallRuleProperties
• Added enum GeoRedundancyState
• Added model HorizonDbClusterDataEncryption
• Added model HorizonDbClusterDataEncryptionForPatchUpdate
• Added enum HorizonDbClusterDataEncryptionType
• Added enum HorizonDbClusterEncryptionKeyStatus
• Added enum HorizonDbClusterIdentityType
• Added model HorizonDbClusterManagedServiceIdentity
• Added model IdentityAssignment
• Added model IdentityValidationStatus
• Added model LogCaptureConfiguration
• Added model LogCaptureConfigurationForPatchUpdate
• Added model LogCaptureConfigurationProperties
• Added model LogCaptureConfigurationPropertiesForPatchUpdate
• Added enum LogCaptureState
• Added model LogFile
• Added model LogFileDownloadUrl
• Added model LogFileProperties
• Added enum LogFileType
• Added model MaintenanceEvent
• Added model MaintenanceEventActionResponse
• Added model MaintenanceEventProperties
• Added model MaintenanceEventRescheduleRequest
• Added enum MaintenanceEventStatus
• Added enum MaintenanceType
• Added model MicrosoftEntraAdministrator
• Added model MicrosoftEntraAdministratorAdd
• Added model MicrosoftEntraAdministratorProperties
• Added model MicrosoftEntraAdministratorPropertiesForAdd
• Added model MicrosoftEntraAuthentication
• Added model MicrosoftEntraAuthenticationForPatchUpdate
• Added enum MicrosoftEntraAuthenticationName
• Added model MicrosoftEntraAuthenticationProperties
• Added model MicrosoftEntraAuthenticationPropertiesForPatchUpdate
• Added model NetworkForPatchUpdate
• Added model Node
• Added model NodeProperties
• Added enum NodeRole
• Added enum ParameterApplyMethod
• Added model ParameterGroup
• Added model ParameterGroupConnectionProperties
• Added model ParameterGroupForPatchUpdate
• Added model ParameterGroupProperties
• Added model ParameterGroupPropertiesForPatchUpdate
• Added enum ParameterGroupSyncStatus
• Added enum ParameterValueSource
• Added model PasswordAuthentication
• Added model PasswordAuthenticationForPatchUpdate
• Added enum PasswordAuthenticationName
• Added model PasswordAuthenticationProperties
• Added model PasswordAuthenticationPropertiesForPatchUpdate
• Added model Pool
• Added model PoolCapability
• Added model PoolComputeModel
• Added model PoolComputeModelForPatchUpdate
• Added enum PoolComputeModelType
• Added model PoolFeatureCapability
• Added model PoolForPatchUpdate
• Added model PoolHighAvailability
• Added enum PoolHighAvailabilityMode
• Added model PoolHighAvailabilityPatch
• Added model PoolParameterGroupReference
• Added model PoolParameterGroupReferenceForPatchUpdate
• Added model PoolProperties
• Added model PoolPropertiesForPatchUpdate
• Added enum PoolState
• Added enum PostgreSqlCapabilityVersion
• Added enum PostgreSqlVersion
• Added model PostgreSqlVersionCapability
• Added model PrivateLinkResource
• Added model ProvisionedComputeModelCapability
• Added model ReadWritePoolProperties
• Added enum ScheduledMaintenanceManagementType
• Added model ScheduledMaintenanceProperties
• Added model ScheduledMaintenancePropertiesForPatchUpdate
• Added model SystemScheduledMaintenanceProperties
• Added operation group AuthenticationsOperations
• Added operation group CapabilitiesOperations
• Added operation group ChangeDataCaptureCapabilitiesOperations
• Added operation group ChangeDataCaptureConfigurationsOperations
• Added operation group ChangeDataCaptureDestinationsOperations
• Added operation group DefaultParameterGroupsOperations
• Added operation group EndpointsOperations
• Added operation group IdentityAssignmentsOperations
• Added operation group LogCaptureConfigurationsOperations
• Added operation group LogFilesOperations
• Added operation group MaintenanceEventsOperations
• Added operation group MicrosoftEntraAdministratorsOperations
• Added operation group MicrosoftEntraAuthenticationsOperations
• Added operation group NodesOperations
• Added operation group PasswordAuthenticationsOperations

Breaking Changes

• Model Network deleted or renamed its instance variable public_network_access
• Deleted or renamed model CreateModeCluster
• Deleted or renamed model CreateModePool
• Deleted or renamed model HorizonDbAdministrator
• Deleted or renamed model HorizonDbAdministratorAdd
• Deleted or renamed model HorizonDbAdministratorProperties
• Deleted or renamed model HorizonDbAdministratorPropertiesForAdd
• Deleted or renamed model HorizonDbCluster
• Deleted or renamed model HorizonDbClusterAuthConfig
• Deleted or renamed model HorizonDbClusterForPatchUpdate
• Deleted or renamed model HorizonDbClusterMirroring
• Deleted or renamed model HorizonDbClusterParameterGroupConnectionProperties
• Deleted or renamed model HorizonDbClusterProperties
• Deleted or renamed model HorizonDbClusterPropertiesForPatchUpdate
• Deleted or renamed model HorizonDbComputeModel
• Deleted or renamed model HorizonDbComputeModelType
• Deleted or renamed model HorizonDbFirewallRule
• Deleted or renamed model HorizonDbFirewallRuleProperties
• Deleted or renamed model HorizonDbParameterGroup
• Deleted or renamed model HorizonDbParameterGroupConnectionProperties
• Deleted or renamed model HorizonDbParameterGroupForPatchUpdate
• Deleted or renamed model HorizonDbParameterGroupProperties
• Deleted or renamed model HorizonDbParameterGroupPropertiesForPatchUpdate
• Deleted or renamed model HorizonDbPool
• Deleted or renamed model HorizonDbPoolProperties
• Deleted or renamed model HorizonDbPrivateLinkResource
• Deleted or renamed model HorizonDbReplica
• Deleted or renamed model HorizonDbReplicaForPatchUpdate
• Deleted or renamed model HorizonDbReplicaProperties
• Deleted or renamed model HorizonDbReplicaPropertiesForPatchUpdate
• Deleted or renamed model ManagedServiceIdentity
• Deleted or renamed model ManagedServiceIdentityType
• Deleted or renamed model ReplicaRole
• Deleted or renamed model State
• Deleted or renamed model ZonePlacementPolicy
• Deleted or renamed operation group HorizonDbAdministratorsOperations
• Deleted or renamed operation group HorizonDbReplicasOperations
• Renamed operation group HorizonDbClustersOperations to ClustersOperations
• Renamed operation group HorizonDbFirewallRulesOperations to FirewallRulesOperations
• Renamed operation group HorizonDbParameterGroupsOperations to ParameterGroupsOperations
• Renamed operation group HorizonDbPoolsOperations to PoolsOperations
• Renamed operation group HorizonDbPrivateEndpointConnectionsOperations to PrivateEndpointConnectionsOperations
• Renamed operation group HorizonDbPrivateLinkResourcesOperations to PrivateLinkResourcesOperations

1.0.0b2 (2026-08-20)

Features Added

• Client HorizonDBMgmtClient added operation group horizon_db_administrators
• Model HorizonDbCluster added property identity
• Model HorizonDbClusterForPatchUpdate added property identity
• Model HorizonDbClusterProperties added property auth_config
• Model HorizonDbClusterProperties added property compute_model
• Model HorizonDbClusterProperties added property mirroring
• Model HorizonDbClusterPropertiesForPatchUpdate added property auth_config
• Model HorizonDbClusterPropertiesForPatchUpdate added property compute_model
• Model HorizonDbClusterPropertiesForPatchUpdate added property mirroring
• Enum State added member SUCCEEDED
• Enum State added member UPGRADING
• Added enum AuthenticationState
• Added model HorizonDbAdministrator
• Added model HorizonDbAdministratorAdd
• Added model HorizonDbAdministratorProperties
• Added model HorizonDbAdministratorPropertiesForAdd
• Added model HorizonDbClusterAuthConfig
• Added model HorizonDbClusterMirroring
• Added model HorizonDbComputeModel
• Added enum HorizonDbComputeModelType
• Added model ManagedServiceIdentity
• Added enum ManagedServiceIdentityType
• Added enum PrincipalTypes
• Added model UserAssignedIdentity
• Operation group HorizonDbClustersOperations added method begin_restart
• Operation group HorizonDbClustersOperations added method begin_start
• Operation group HorizonDbClustersOperations added method begin_stop
• Added operation group HorizonDbAdministratorsOperations

Breaking Changes

• Deleted or renamed model OptionalPropertiesUpdateableProperties
• Deleted or renamed model PrivateEndpointConnection
• Deleted or renamed model PrivateEndpointConnectionUpdate
• Method HorizonDbPrivateEndpointConnectionsOperations.begin_delete inserted a positional_or_keyword parameter cluster_name
• Renamed method HorizonDbPrivateEndpointConnectionsOperations.begin_update to update_status

1.0.0b1 (2026-04-22)

Other Changes

• Initial version