@azure/arm-horizondb package

Classes

HorizonDbClient

Interfaces

ActivateChangeDataCaptureIdentityRequest	The request to activate an identity assignment for a change data capture destination.
ActivateChangeDataCaptureIdentityResult	The completed result of activating a change data capture destination identity.
Authentication	A service-created authentication configuration returned by the authentications collection. The resource name is passwordMethod or microsoftEntra.
AuthenticationProperties	Common read-only properties of a service-created authentication configuration.
AuthenticationsListOptionalParams	Optional parameters.
AuthenticationsOperations	Interface representing a Authentications operations.
BackupProperties	Backup configuration properties for a HorizonDB cluster.
BackupPropertiesCreateOrUpdate	Backup configuration properties for a HorizonDB cluster.
BackupPropertiesForPatchUpdate	Backup configuration properties for updating a HorizonDB cluster.
BackupPropertiesForPatchUpdateUpdate	Backup configuration properties for updating a HorizonDB cluster.
CapabilitiesGetOptionalParams	Optional parameters.
CapabilitiesListOptionalParams	Optional parameters.
CapabilitiesOperations	Interface representing a Capabilities operations.
Capability	The singleton HorizonDB capability catalog entry available to a subscription in a location.
CapabilityProperties	Properties of the HorizonDB capabilities available to a subscription in a location.
ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams	Optional parameters.
ChangeDataCaptureCapabilitiesDeleteOptionalParams	Optional parameters.
ChangeDataCaptureCapabilitiesGetOptionalParams	Optional parameters.
ChangeDataCaptureCapabilitiesListOptionalParams	Optional parameters.
ChangeDataCaptureCapabilitiesOperations	Interface representing a ChangeDataCaptureCapabilities operations.
ChangeDataCaptureCapabilitiesUpdateOptionalParams	Optional parameters.
ChangeDataCaptureCapability	The singleton change data capture capability for a HorizonDB cluster.
ChangeDataCaptureCapabilityCreateOrUpdate	The singleton change data capture capability for a HorizonDB cluster.
ChangeDataCaptureCapabilityForPatchUpdate	A sparse update request for the singleton change data capture capability.
ChangeDataCaptureCapabilityForPatchUpdateUpdate	A sparse update request for the singleton change data capture capability.
ChangeDataCaptureCapabilityProperties	The properties of the singleton change data capture capability.
ChangeDataCaptureCapabilityPropertiesCreateOrUpdate	The properties of the singleton change data capture capability.
ChangeDataCaptureCapabilityPropertiesForPatchUpdate	Properties for updating the singleton change data capture capability. Omitted properties preserve their current values.
ChangeDataCaptureCapabilityPropertiesForPatchUpdateUpdate	Properties for updating the singleton change data capture capability. Omitted properties preserve their current values.
ChangeDataCaptureConfiguration	A HorizonDB database enrollment for Microsoft Fabric Mirroring.
ChangeDataCaptureConfigurationCreateOrUpdate	A HorizonDB database enrollment for Microsoft Fabric Mirroring.
ChangeDataCaptureConfigurationForPatchUpdate	A sparse update request for a change data capture configuration.
ChangeDataCaptureConfigurationForPatchUpdateUpdate	A sparse update request for a change data capture configuration.
ChangeDataCaptureConfigurationProperties	The properties of a Microsoft Fabric Mirroring configuration.
ChangeDataCaptureConfigurationPropertiesCreateOrUpdate	The properties of a Microsoft Fabric Mirroring configuration.
ChangeDataCaptureConfigurationPropertiesForPatchUpdate	Properties for updating a change data capture configuration. Omitted properties preserve their current values.
ChangeDataCaptureConfigurationPropertiesForPatchUpdateUpdate	Properties for updating a change data capture configuration. Omitted properties preserve their current values.
ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams	Optional parameters.
ChangeDataCaptureConfigurationsDeleteOptionalParams	Optional parameters.
ChangeDataCaptureConfigurationsGetOptionalParams	Optional parameters.
ChangeDataCaptureConfigurationsListOptionalParams	Optional parameters.
ChangeDataCaptureConfigurationsOperations	Interface representing a ChangeDataCaptureConfigurations operations.
ChangeDataCaptureConfigurationsUpdateOptionalParams	Optional parameters.
ChangeDataCaptureDestination	A reusable Microsoft Fabric destination for HorizonDB change data capture configurations.
ChangeDataCaptureDestinationCreateOrUpdate	A reusable Microsoft Fabric destination for HorizonDB change data capture configurations.
ChangeDataCaptureDestinationDetails	Destination-specific settings discriminated by destinationType.
ChangeDataCaptureDestinationForPatchUpdate	A sparse update request for a change data capture destination.
ChangeDataCaptureDestinationForPatchUpdateUpdate	A sparse update request for a change data capture destination.
ChangeDataCaptureDestinationProperties	The properties of a Microsoft Fabric change data capture destination.
ChangeDataCaptureDestinationPropertiesCreateOrUpdate	The properties of a Microsoft Fabric change data capture destination.
ChangeDataCaptureDestinationPropertiesForPatchUpdate	Properties for updating a change data capture destination. Omitted properties preserve their current values.
ChangeDataCaptureDestinationPropertiesForPatchUpdateUpdate	Properties for updating a change data capture destination. Omitted properties preserve their current values.
ChangeDataCaptureDestinationsActivateIdentityOptionalParams	Optional parameters.
ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams	Optional parameters.
ChangeDataCaptureDestinationsDeleteOptionalParams	Optional parameters.
ChangeDataCaptureDestinationsGetOptionalParams	Optional parameters.
ChangeDataCaptureDestinationsListOptionalParams	Optional parameters.
ChangeDataCaptureDestinationsOperations	Interface representing a ChangeDataCaptureDestinations operations.
ChangeDataCaptureDestinationsUpdateOptionalParams	Optional parameters.
ChangeDataCaptureExtensionStatus	The installed HorizonDB change data capture extension and its current state.
ChangeDataCaptureIdentityAssignmentProperties	The properties of a change data capture identity assignment.
ChangeDataCaptureIdentityAssignmentPropertiesCreateOrUpdate	The properties of a change data capture identity assignment.
ChangeDataCapturePrerequisiteStatus	The current readiness of prerequisites shared by change data capture configurations.
ChangeDataCaptureReplicationStatus	The destination-owned replication-session status known to HorizonDB.
ChangeDataCaptureStatus	Customer-safe health information for a HorizonDB change data capture resource.
ChangeDataCaptureTopologyBindingStatus	The current writer-topology binding of a change data capture configuration.
Cluster	Represents the HorizonDB cluster.
ClusterCapability	The HorizonDB Cluster capabilities available in a location.
ClusterCreateOrUpdate	Represents the HorizonDB cluster.
ClusterFeatureCapability	A HorizonDB Cluster feature supported in a location.
ClusterForPatchUpdate	HorizonDB cluster for update operations.
ClusterForPatchUpdateUpdate	HorizonDB cluster for update operations.
ClusterProperties	Properties of a HorizonDB cluster.
ClusterPropertiesCreateOrUpdate	Properties of a HorizonDB cluster.
ClusterPropertiesForPatchUpdate	Properties of a HorizonDB cluster for update operations.
ClusterPropertiesForPatchUpdateUpdate	Properties of a HorizonDB cluster for update operations.
ClustersCreateOrReplaceOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersFailoverOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListBySubscriptionOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ClustersUpdateOptionalParams	Optional parameters.
ComputeGenerationCapability	The capabilities of a HorizonDB compute generation.
ComputeModelCapability	The capabilities of a HorizonDB compute model.
ComputeProcessorCapability	The capabilities of a processor family supported by HorizonDB.
ComputeSizeCapability	A vCore configuration supported by a HorizonDB processor generation.
DefaultParameterGroup	A default parameter group available in a specific region. It contains engine-defined parameters and excludes service and other non-engine entries. For each PostgreSQL version, the DefaultParameterGroups APIs return at most one default parameter group in a location.
DefaultParameterGroupProperties	Properties of a default parameter group.
DefaultParameterGroupsGetOptionalParams	Optional parameters.
DefaultParameterGroupsListBySubscriptionAndRegionOptionalParams	Optional parameters.
DefaultParameterGroupsOperations	Interface representing a DefaultParameterGroups operations.
Endpoint	Represents a service-generated, service-managed HorizonDB endpoint. The Cluster-scoped Endpoint is created and deleted with its parent Cluster. A Pool-scoped Endpoint is created and deleted with the Pool identified by associatedResourceId. Endpoints cannot be created or deleted independently from their lifecycle owner.
EndpointProperties	Properties of a service-generated HorizonDB endpoint.
EndpointsGetOptionalParams	Optional parameters.
EndpointsListOptionalParams	Optional parameters.
EndpointsOperations	Interface representing a Endpoints operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FabricDestinationDetails	Settings for a Microsoft Fabric destination.
FirewallRule	Represents a customer-managed firewall rule for a HorizonDB pool.
FirewallRuleCreateOrUpdate	Represents a customer-managed firewall rule for a HorizonDB pool.
FirewallRuleProperties	Properties of a HorizonDB firewall rule.
FirewallRulePropertiesCreateOrUpdate	Properties of a HorizonDB firewall rule.
FirewallRulesCreateOrReplaceOptionalParams	Optional parameters.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListOptionalParams	Optional parameters.
FirewallRulesOperations	Interface representing a FirewallRules operations.
HorizonDbClientOptionalParams	Optional parameters for the client.
HorizonDbClusterDataEncryption	The Cluster-level data encryption configuration. The encryption type is selected at cluster creation; switching between SystemManaged and AzureKeyVault after creation is not supported. For AzureKeyVault encryption, primaryKeyUri and primaryUserAssignedIdentityId are required, and backup.geoRedundancy must be Disabled. Both primaryKeyUri and primaryUserAssignedIdentityId can be provided during initial cluster creation. For updates to an existing cluster through PUT or PATCH, only one of these properties can change per request, and that update must complete before submitting a separate update to change the other property. Customer-managed key identities must also be assigned to the Cluster through its top-level identity property. Only versionless Azure Key Vault key URIs are supported; key version paths are rejected. For SystemManaged encryption, key and identity properties must be omitted.
HorizonDbClusterDataEncryptionCreateOrUpdate	The Cluster-level data encryption configuration. The encryption type is selected at cluster creation; switching between SystemManaged and AzureKeyVault after creation is not supported. For AzureKeyVault encryption, primaryKeyUri and primaryUserAssignedIdentityId are required, and backup.geoRedundancy must be Disabled. Both primaryKeyUri and primaryUserAssignedIdentityId can be provided during initial cluster creation. For updates to an existing cluster through PUT or PATCH, only one of these properties can change per request, and that update must complete before submitting a separate update to change the other property. Customer-managed key identities must also be assigned to the Cluster through its top-level identity property. Only versionless Azure Key Vault key URIs are supported; key version paths are rejected. For SystemManaged encryption, key and identity properties must be omitted.
HorizonDbClusterDataEncryptionForPatchUpdate	Properties for sparsely updating Cluster-level data encryption. Omitted properties preserve their current values. Updates can modify settings within the existing encryption type, such as the primary Azure Key Vault key URI, but switching between SystemManaged and AzureKeyVault after cluster creation is not supported. AzureKeyVault encryption is not supported when backup.geoRedundancy is Enabled. An update can change only one of primaryKeyUri or primaryUserAssignedIdentityId; that update must complete before submitting a separate update to change the other property.
HorizonDbClusterDataEncryptionForPatchUpdateUpdate	Properties for sparsely updating Cluster-level data encryption. Omitted properties preserve their current values. Updates can modify settings within the existing encryption type, such as the primary Azure Key Vault key URI, but switching between SystemManaged and AzureKeyVault after cluster creation is not supported. AzureKeyVault encryption is not supported when backup.geoRedundancy is Enabled. An update can change only one of primaryKeyUri or primaryUserAssignedIdentityId; that update must complete before submitting a separate update to change the other property.
HorizonDbClusterManagedServiceIdentity	The user-assigned managed identities assigned to a HorizonDB cluster. Omitting the entire top-level identity property from PUT or PATCH preserves all current assignments. When userAssignedIdentities is supplied, PUT replaces the complete set and PATCH merges the supplied entries with the existing set; a null PATCH entry removes that individual identity. Setting type to None clears all assignments. Removing an identity referenced by a change data capture identity assignment is rejected until the referencing assignment is deleted.
HorizonDbClusterManagedServiceIdentityCreateOrUpdate	The user-assigned managed identities assigned to a HorizonDB cluster. Omitting the entire top-level identity property from PUT or PATCH preserves all current assignments. When userAssignedIdentities is supplied, PUT replaces the complete set and PATCH merges the supplied entries with the existing set; a null PATCH entry removes that individual identity. Setting type to None clears all assignments. Removing an identity referenced by a change data capture identity assignment is rejected until the referencing assignment is deleted.
HorizonDbClusterManagedServiceIdentityUpdate	The user-assigned managed identities assigned to a HorizonDB cluster. Omitting the entire top-level identity property from PUT or PATCH preserves all current assignments. When userAssignedIdentities is supplied, PUT replaces the complete set and PATCH merges the supplied entries with the existing set; a null PATCH entry removes that individual identity. Setting type to None clears all assignments. Removing an identity referenced by a change data capture identity assignment is rejected until the referencing assignment is deleted.
IdentityAssignment	A user-assigned managed identity authorized for a HorizonDB change data capture destination.
IdentityAssignmentCreateOrUpdate	A user-assigned managed identity authorized for a HorizonDB change data capture destination.
IdentityAssignmentsCreateOrReplaceOptionalParams	Optional parameters.
IdentityAssignmentsDeleteOptionalParams	Optional parameters.
IdentityAssignmentsGetOptionalParams	Optional parameters.
IdentityAssignmentsListOptionalParams	Optional parameters.
IdentityAssignmentsOperations	Interface representing a IdentityAssignments operations.
IdentityValidationStatus	The current validation result for a change data capture identity assignment.
LogCaptureConfiguration	A predefined log capture configuration created by the service for a HorizonDB cluster.
LogCaptureConfigurationForPatchUpdate	A sparse update request for a log capture configuration.
LogCaptureConfigurationForPatchUpdateUpdate	A sparse update request for a log capture configuration.
LogCaptureConfigurationProperties	The settings for capturing a specific type of HorizonDB log.
LogCaptureConfigurationPropertiesForPatchUpdate	Properties for updating the log capture configuration. Omitted properties preserve their current values.
LogCaptureConfigurationPropertiesForPatchUpdateUpdate	Properties for updating the log capture configuration. Omitted properties preserve their current values.
LogCaptureConfigurationsGetOptionalParams	Optional parameters.
LogCaptureConfigurationsListOptionalParams	Optional parameters.
LogCaptureConfigurationsOperations	Interface representing a LogCaptureConfigurations operations.
LogCaptureConfigurationsUpdateOptionalParams	Optional parameters.
LogFile	A service-generated log file captured for a HorizonDB cluster.
LogFileDownloadUrl	A short-lived signed URL for downloading a captured log file.
LogFileProperties	Metadata for a service-generated HorizonDB log file.
LogFilesGetOptionalParams	Optional parameters.
LogFilesListDownloadUrlsOptionalParams	Optional parameters.
LogFilesListOptionalParams	Optional parameters.
LogFilesOperations	Interface representing a LogFiles operations.
MaintenanceEvent	Represents a maintenance event for a HorizonDB pool.
MaintenanceEventActionResponse	The response from a maintenance event reschedule or apply-now action.
MaintenanceEventProperties	Properties of a maintenance event resource.
MaintenanceEventRescheduleRequest	Parameters for rescheduling a maintenance event.
MaintenanceEventsApplyNowOptionalParams	Optional parameters.
MaintenanceEventsGetOptionalParams	Optional parameters.
MaintenanceEventsListOptionalParams	Optional parameters.
MaintenanceEventsOperations	Interface representing a MaintenanceEvents operations.
MaintenanceEventsRescheduleOptionalParams	Optional parameters.
MicrosoftEntraAdministrator	Represents a PostgreSQL role that is a member of the azure_pg_admin role and is mapped to a Microsoft Entra principal.
MicrosoftEntraAdministratorAdd	The request body for creating or updating a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.
MicrosoftEntraAdministratorProperties	Properties of a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.
MicrosoftEntraAdministratorPropertiesForAdd	Properties for creating or updating a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.
MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams	Optional parameters.
MicrosoftEntraAdministratorsDeleteOptionalParams	Optional parameters.
MicrosoftEntraAdministratorsGetOptionalParams	Optional parameters.
MicrosoftEntraAdministratorsListOptionalParams	Optional parameters.
MicrosoftEntraAdministratorsOperations	Interface representing a MicrosoftEntraAdministrators operations.
MicrosoftEntraAuthentication	The service-created Microsoft Entra authentication method for a HorizonDB cluster.
MicrosoftEntraAuthenticationCreateOrUpdate	The service-created Microsoft Entra authentication method for a HorizonDB cluster.
MicrosoftEntraAuthenticationForPatchUpdate	A sparse update request for Microsoft Entra authentication.
MicrosoftEntraAuthenticationForPatchUpdateUpdate	A sparse update request for Microsoft Entra authentication.
MicrosoftEntraAuthenticationProperties	Properties of the service-created Microsoft Entra authentication method.
MicrosoftEntraAuthenticationPropertiesCreateOrUpdate	Properties of the service-created Microsoft Entra authentication method.
MicrosoftEntraAuthenticationPropertiesForPatchUpdate	Properties for updating Microsoft Entra authentication. State Enabled enables the feature and State Disabled disables it. Disabling Microsoft Entra authentication does not remove or modify database roles or users previously created through the MicrosoftEntraAdministrators control-plane API or directly through pgaadauth extension functions.
MicrosoftEntraAuthenticationPropertiesForPatchUpdateUpdate	Properties for updating Microsoft Entra authentication. State Enabled enables the feature and State Disabled disables it. Disabling Microsoft Entra authentication does not remove or modify database roles or users previously created through the MicrosoftEntraAdministrators control-plane API or directly through pgaadauth extension functions.
MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams	Optional parameters.
MicrosoftEntraAuthenticationsGetOptionalParams	Optional parameters.
MicrosoftEntraAuthenticationsOperations	Interface representing a MicrosoftEntraAuthentications operations.
MicrosoftEntraAuthenticationsUpdateOptionalParams	Optional parameters.
Network	Network properties.
NetworkForPatchUpdate	Network properties for updating a HorizonDB cluster.
NetworkForPatchUpdateUpdate	Network properties for updating a HorizonDB cluster.
Node	A service-managed node allocated to a HorizonDB pool.
NodeProperties	Properties of a service-managed HorizonDB node.
NodesGetOptionalParams	Optional parameters.
NodesListOptionalParams	Optional parameters.
NodesOperations	Interface representing a Nodes operations.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ParameterGroup	Represents the HorizonDB parameter group.
ParameterGroupConnectionProperties	Connection information for HorizonDB parameter group.
ParameterGroupCreateOrUpdate	Represents the HorizonDB parameter group.
ParameterGroupForPatchUpdate	HorizonDB parameter group for update operations.
ParameterGroupForPatchUpdateUpdate	HorizonDB parameter group for update operations.
ParameterGroupProperties	Properties of a HorizonDB parameter group.
ParameterGroupPropertiesCreateOrUpdate	Properties of a HorizonDB parameter group.
ParameterGroupPropertiesForPatchUpdate	Properties of a HorizonDB parameter group for update operations.
ParameterGroupPropertiesForPatchUpdateUpdate	Properties of a HorizonDB parameter group for update operations.
ParameterGroupsCreateOrReplaceOptionalParams	Optional parameters.
ParameterGroupsDeleteOptionalParams	Optional parameters.
ParameterGroupsGetOptionalParams	Optional parameters.
ParameterGroupsListByResourceGroupOptionalParams	Optional parameters.
ParameterGroupsListBySubscriptionOptionalParams	Optional parameters.
ParameterGroupsListConnectionsOptionalParams	Optional parameters.
ParameterGroupsOperations	Interface representing a ParameterGroups operations.
ParameterGroupsUpdateOptionalParams	Optional parameters.
ParameterProperties	Properties of a HorizonDB parameter.
ParameterPropertiesCreateOrUpdate	Properties of a HorizonDB parameter.
ParameterPropertiesUpdate	Properties of a HorizonDB parameter.
PasswordAuthentication	The service-created PostgreSQL username-and-password authentication method for a HorizonDB cluster. This resource configures the authentication mechanism, including its enabled state and administrator login credentials; it is not a password-only resource.
PasswordAuthenticationCreateOrUpdate	The service-created PostgreSQL username-and-password authentication method for a HorizonDB cluster. This resource configures the authentication mechanism, including its enabled state and administrator login credentials; it is not a password-only resource.
PasswordAuthenticationForPatchUpdate	A sparse update request for PostgreSQL username-and-password authentication.
PasswordAuthenticationForPatchUpdateUpdate	A sparse update request for PostgreSQL username-and-password authentication.
PasswordAuthenticationProperties	Properties of the service-created PostgreSQL username-and-password authentication method.
PasswordAuthenticationPropertiesCreateOrUpdate	Properties of the service-created PostgreSQL username-and-password authentication method.
PasswordAuthenticationPropertiesForPatchUpdate	Properties for updating PostgreSQL username-and-password authentication. Omitted properties preserve their current values. This API version supports enabling or disabling the authentication method, and resetting its password. Supported changes can be combined.
PasswordAuthenticationPropertiesForPatchUpdateUpdate	Properties for updating PostgreSQL username-and-password authentication. Omitted properties preserve their current values. This API version supports enabling or disabling the authentication method, and resetting its password. Supported changes can be combined.
PasswordAuthenticationsCreateOrReplaceOptionalParams	Optional parameters.
PasswordAuthenticationsGetOptionalParams	Optional parameters.
PasswordAuthenticationsOperations	Interface representing a PasswordAuthentications operations.
PasswordAuthenticationsUpdateOptionalParams	Optional parameters.
Pool	Represents the HorizonDB pool.
PoolCapability	The HorizonDB Pool capabilities available in a location.
PoolComputeModel	The compute model for a HorizonDB pool.
PoolComputeModelForPatchUpdate	The compute model properties of a HorizonDB pool that can be updated. The object is recursively mergeable: omitted properties preserve their current values. Properties that do not apply to the current or target compute model type are rejected. When type changes, the request must include the complete target compute model. Subtype-specific constraints are validated against the effective merged configuration; invalid requests are rejected without changing the resource.
PoolComputeModelForPatchUpdateUpdate	The compute model properties of a HorizonDB pool that can be updated. The object is recursively mergeable: omitted properties preserve their current values. Properties that do not apply to the current or target compute model type are rejected. When type changes, the request must include the complete target compute model. Subtype-specific constraints are validated against the effective merged configuration; invalid requests are rejected without changing the resource.
PoolCreateOrUpdate	Represents the HorizonDB pool.
PoolFeatureCapability	A HorizonDB Pool feature supported in a location.
PoolForPatchUpdate	HorizonDB pool for update operations.
PoolForPatchUpdateUpdate	HorizonDB pool for update operations.
PoolHighAvailability	The high-availability configuration for a HorizonDB pool.
PoolHighAvailabilityPatch	The high-availability configuration for a HorizonDB pool update.
PoolHighAvailabilityPatchUpdate	The high-availability configuration for a HorizonDB pool update.
PoolParameterGroupReference	A reference to the parameter group associated with a HorizonDB pool. The schema represents both default and customer-created parameter groups for create and update compatibility. In this API version, initial pool creation accepts only the corresponding default parameter group; PUT updates to an existing pool can associate either group type.
PoolParameterGroupReferenceCreateOrUpdate	A reference to the parameter group associated with a HorizonDB pool. The schema represents both default and customer-created parameter groups for create and update compatibility. In this API version, initial pool creation accepts only the corresponding default parameter group; PUT updates to an existing pool can associate either group type.
PoolParameterGroupReferenceForPatchUpdate	A parameter group reference for updating an existing HorizonDB pool. The pool can switch in either direction between its corresponding default parameter group and a customer-created parameter group.
PoolParameterGroupReferenceForPatchUpdateUpdate	A parameter group reference for updating an existing HorizonDB pool. The pool can switch in either direction between its corresponding default parameter group and a customer-created parameter group.
PoolProperties	Properties of a HorizonDB pool.
PoolPropertiesCreateOrUpdate	Properties of a HorizonDB pool.
PoolPropertiesForPatchUpdate	Properties of a HorizonDB pool for update operations.
PoolPropertiesForPatchUpdateUpdate	Properties of a HorizonDB pool for update operations.
PoolsCreateOrReplaceOptionalParams	Optional parameters.
PoolsDeleteOptionalParams	Optional parameters.
PoolsGetOptionalParams	Optional parameters.
PoolsListOptionalParams	Optional parameters.
PoolsOperations	Interface representing a Pools operations.
PoolsRestartOptionalParams	Optional parameters.
PoolsStartOptionalParams	Optional parameters.
PoolsStopOptionalParams	Optional parameters.
PoolsUpdateOptionalParams	Optional parameters.
PostgreSqlVersionCapability	The capabilities of a PostgreSQL major version supported by HorizonDB.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionPropertiesCreateOrUpdate	Properties of the private endpoint connection.
PrivateEndpointConnectionResource	A private endpoint connection resource
PrivateEndpointConnectionResourceCreateOrUpdate	A private endpoint connection resource
PrivateEndpointConnectionsApproveOrRejectOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateEndpointCreateOrUpdate	The private endpoint resource.
PrivateLinkResource	Represents the HorizonDB private link resource.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProvisionedComputeModelCapability	The capabilities of the Provisioned compute model.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ProxyResourceCreateOrUpdate	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ReadWritePoolProperties	The pool currently designated to host a HorizonDB cluster's read-write node. When a pool is created while the cluster currently has no pools, the service automatically designates the new pool as the read-write pool. This behavior also applies after all pools that existed earlier in the cluster's lifetime have been deleted.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceCreateOrUpdate	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ScheduledMaintenanceProperties	The scheduled maintenance configuration for a HorizonDB pool.
ScheduledMaintenancePropertiesForPatchUpdate	The scheduled maintenance configuration for a pool update operation.
ScheduledMaintenancePropertiesForPatchUpdateUpdate	The scheduled maintenance configuration for a pool update operation.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemData	Metadata pertaining to creation and last modification of the resource.
SystemScheduledMaintenanceProperties	The system-managed scheduled maintenance configuration for a HorizonDB pool. User-managed schedule properties must be absent.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrackedResourceCreateOrUpdate	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
UserAssignedIdentityCreateOrUpdate	User assigned identity properties
UserAssignedIdentityUpdate	User assigned identity properties

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AiModelManagementStatus	The AI Model Management status for a HorizonDB cluster. KnownAiModelManagementStatus can be used interchangeably with AiModelManagementStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled: AI Model Management is enabled. Disabled: AI Model Management is disabled.
AuthenticationName	The name of a service-created authentication configuration. KnownAuthenticationName can be used interchangeably with AuthenticationName, this enum contains the known values that the service supports. Known values supported by the service passwordMethod: PostgreSQL username-and-password authentication. microsoftEntra: Microsoft Entra authentication.
AuthenticationState	Indicates if authentication state is enabled or not. KnownAuthenticationState can be used interchangeably with AuthenticationState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Is enabled Disabled: Is disabled
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ChangeDataCaptureDesiredState	The requested state of a HorizonDB change data capture capability, destination, or configuration. KnownChangeDataCaptureDesiredState can be used interchangeably with ChangeDataCaptureDesiredState, this enum contains the known values that the service supports. Known values supported by the service Enabled: The resource should be enabled. Disabled: The resource should be disabled.
ChangeDataCaptureDestinationDetailsUnion	Alias for ChangeDataCaptureDestinationDetailsUnion
ChangeDataCaptureDestinationEffectiveState	The effective state of a HorizonDB change data capture destination. KnownChangeDataCaptureDestinationEffectiveState can be used interchangeably with ChangeDataCaptureDestinationEffectiveState, this enum contains the known values that the service supports. Known values supported by the service WaitingForIdentity: The destination is waiting for a validated active identity assignment. Enabling: The destination is being enabled. Enabled: The destination is enabled. Disabling: The destination is being disabled. Disabled: The destination is disabled. Degraded: The destination is available with reduced functionality or impaired health. Failed: The destination is not operational because reconciliation failed.
ChangeDataCaptureDestinationType	The destination type supported by this API version. KnownChangeDataCaptureDestinationType can be used interchangeably with ChangeDataCaptureDestinationType, this enum contains the known values that the service supports. Known values supported by the service Fabric: A Microsoft Fabric destination.
ChangeDataCaptureEffectiveState	The effective state of a HorizonDB change data capture capability or configuration. KnownChangeDataCaptureEffectiveState can be used interchangeably with ChangeDataCaptureEffectiveState, this enum contains the known values that the service supports. Known values supported by the service Enabling: The resource is being enabled. Enabled: The resource is enabled. Disabling: The resource is being disabled. Disabled: The resource is disabled. Degraded: The resource is available with reduced functionality or impaired health. Failed: The resource is not operational because reconciliation failed.
ChangeDataCaptureEngineConfigurationState	The readiness of HorizonDB engine settings required for change data capture. KnownChangeDataCaptureEngineConfigurationState can be used interchangeably with ChangeDataCaptureEngineConfigurationState, this enum contains the known values that the service supports. Known values supported by the service Ready: The required engine settings are ready. NotReady: One or more required engine settings are not ready. Reconciling: The service is reconciling required engine settings. Failed: Engine-setting reconciliation failed.
ChangeDataCaptureExtensionState	The lifecycle state of the HorizonDB change data capture extension. KnownChangeDataCaptureExtensionState can be used interchangeably with ChangeDataCaptureExtensionState, this enum contains the known values that the service supports. Known values supported by the service NotInstalled: The extension is not installed. Installing: The extension is being installed. Ready: The extension is ready. Upgrading: The extension is being upgraded. Removing: The extension is being removed. Failed: The extension operation failed.
ChangeDataCaptureIdentityActivationState	The activation state of a change data capture identity assignment. KnownChangeDataCaptureIdentityActivationState can be used interchangeably with ChangeDataCaptureIdentityActivationState, this enum contains the known values that the service supports. Known values supported by the service Inactive: The identity assignment is not active. Activating: The identity assignment is being activated. Active: The identity assignment is active. Deactivating: The identity assignment is being deactivated. Failed: The identity activation transition failed.
ChangeDataCaptureIdentityAssignmentState	The lifecycle state of a change data capture identity assignment. KnownChangeDataCaptureIdentityAssignmentState can be used interchangeably with ChangeDataCaptureIdentityAssignmentState, this enum contains the known values that the service supports. Known values supported by the service Assigning: The identity is being assigned. Assigned: The identity is assigned. Removing: The identity assignment is being removed. Failed: The identity assignment operation failed.
ChangeDataCaptureIdentityValidationState	The validation state of a change data capture identity assignment. KnownChangeDataCaptureIdentityValidationState can be used interchangeably with ChangeDataCaptureIdentityValidationState, this enum contains the known values that the service supports. Known values supported by the service NotStarted: Identity validation has not started. Running: Identity validation is running. Succeeded: Identity validation succeeded. Failed: Identity validation failed.
ChangeDataCaptureProtocol	The protocol used to communicate with a change data capture destination. KnownChangeDataCaptureProtocol can be used interchangeably with ChangeDataCaptureProtocol, this enum contains the known values that the service supports. Known values supported by the service Native: The destination's native protocol.
ChangeDataCaptureReadWriteEndpointState	The availability of a read-write endpoint for change data capture engine mutations. KnownChangeDataCaptureReadWriteEndpointState can be used interchangeably with ChangeDataCaptureReadWriteEndpointState, this enum contains the known values that the service supports. Known values supported by the service Ready: An eligible read-write endpoint is ready. Unavailable: No eligible read-write endpoint is currently available.
ChangeDataCaptureReplicationArchitecture	The implementation architecture used to capture and publish changes. KnownChangeDataCaptureReplicationArchitecture can be used interchangeably with ChangeDataCaptureReplicationArchitecture, this enum contains the known values that the service supports. Known values supported by the service ComputeBased: Change capture runs with the HorizonDB compute layer. StorageBased: Change capture runs with the HorizonDB storage layer. Hybrid: Change capture uses both compute and storage components.
ChangeDataCaptureReplicationState	The state of a destination-owned replication session. KnownChangeDataCaptureReplicationState can be used interchangeably with ChangeDataCaptureReplicationState, this enum contains the known values that the service supports. Known values supported by the service NotApplicable: A destination session does not apply to the current resource state. NotConnected: No destination session is connected. Connecting: A destination session is connecting. Replicating: A destination session is replicating changes. Reconnecting: A destination session is reconnecting after an interruption. Paused: The destination session is paused. Stopping: The destination session is stopping. Degraded: The destination session is operating with impaired health. Failed: The destination session failed.
ChangeDataCaptureTopologyBindingState	The relationship of a change data capture configuration to the current writer topology. KnownChangeDataCaptureTopologyBindingState can be used interchangeably with ChangeDataCaptureTopologyBindingState, this enum contains the known values that the service supports. Known values supported by the service Active: The configuration belongs to the current active writer. Reconciling: The service is reconciling the configuration after a writer change. RebindRequired: The destination session must bind to a replacement configuration resource ID. Superseded: The configuration belongs to a former writer and has been replaced. Conflict: Equivalent change data capture state could not be materialized without overwriting unrelated state.
ChangeDataCaptureUsageProfile	The reason that a change data capture configuration exists. KnownChangeDataCaptureUsageProfile can be used interchangeably with ChangeDataCaptureUsageProfile, this enum contains the known values that the service supports. Known values supported by the service Mirroring: The configuration publishes database changes for Microsoft Fabric Mirroring.
ClusterCreateMode	Controls how a HorizonDB cluster PUT request is processed. KnownClusterCreateMode can be used interchangeably with ClusterCreateMode, this enum contains the known values that the service supports. Known values supported by the service Create: Process the request as a normal cluster creation. PointInTimeRestore: Create the cluster from a point-in-time restore.
ClusterState	Current state of a HorizonDB cluster. KnownClusterState can be used interchangeably with ClusterState, this enum contains the known values that the service supports. Known values supported by the service Ready: Is ready and operational Provisioning: Is provisioning Deleting: Is being deleted Inaccessible: Is inaccessible Updating: Is being updated
ComputeModelCapabilityUnion	Alias for ComputeModelCapabilityUnion
ComputeProcessorType	The compute processor type. KnownComputeProcessorType can be used interchangeably with ComputeProcessorType, this enum contains the known values that the service supports. Known values supported by the service Intel: Intel processor AMD: AMD processor
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
EndpointRole	Role of the endpoint. KnownEndpointRole can be used interchangeably with EndpointRole, this enum contains the known values that the service supports. Known values supported by the service ReadOnly: The Endpoint accepts read-only traffic. This applies to Pool-scoped Endpoints and may apply to other endpoint scenarios introduced by later API versions. ReadWrite: The Cluster-scoped Endpoint accepts read and write traffic.
EndpointScope	The scope of a HorizonDB endpoint. KnownEndpointScope can be used interchangeably with EndpointScope, this enum contains the known values that the service supports. Known values supported by the service Cluster: The Endpoint is associated with its parent Cluster. Pool: The Endpoint is associated with a Pool under its parent Cluster and has the ReadOnly role.
GeoRedundancyState	Indicates the geo-redundancy state. KnownGeoRedundancyState can be used interchangeably with GeoRedundancyState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Geo-redundancy is enabled. This value is not supported when dataEncryption.type is AzureKeyVault. Disabled: Geo-redundancy is disabled
HorizonDbClusterDataEncryptionType	The type of data encryption used by a HorizonDB cluster. The type is selected at cluster creation; switching between SystemManaged and AzureKeyVault after creation is not supported. KnownHorizonDbClusterDataEncryptionType can be used interchangeably with HorizonDbClusterDataEncryptionType, this enum contains the known values that the service supports. Known values supported by the service SystemManaged: Data encryption is managed by Azure using platform-managed keys. AzureKeyVault: Data encryption uses customer-managed keys stored in Azure Key Vault.
HorizonDbClusterEncryptionKeyStatus	The validation status of a customer-managed encryption key used by a HorizonDB cluster. KnownHorizonDbClusterEncryptionKeyStatus can be used interchangeably with HorizonDbClusterEncryptionKeyStatus, this enum contains the known values that the service supports. Known values supported by the service Valid: The encryption key is valid and accessible to the configured user-assigned managed identity. Invalid: The encryption key is invalid or inaccessible to the configured user-assigned managed identity.
HorizonDbClusterIdentityType	The managed identity types supported by a HorizonDB cluster. KnownHorizonDbClusterIdentityType can be used interchangeably with HorizonDbClusterIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity is assigned. Setting type to None clears all managed identity assignments. UserAssigned: User-assigned managed identities are assigned.
LogCaptureState	Specifies whether HorizonDB captures log files. KnownLogCaptureState can be used interchangeably with LogCaptureState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Log capture is enabled. Disabled: Log capture is disabled.
LogFileType	The type of a captured HorizonDB log file. KnownLogFileType can be used interchangeably with LogFileType, this enum contains the known values that the service supports. Known values supported by the service PostgreSqlServer: A PostgreSQL server log file.
MaintenanceEventStatus	The status of a maintenance event. KnownMaintenanceEventStatus can be used interchangeably with MaintenanceEventStatus, this enum contains the known values that the service supports. Known values supported by the service Planned: The maintenance event is scheduled and has not yet started. InProgress: The maintenance event is currently in progress. Complete: The maintenance event completed successfully. Rescheduled: The customer rescheduled the maintenance event. Canceled: The maintenance event was canceled, failed, or timed out.
MaintenanceType	The type of a maintenance event. KnownMaintenanceType can be used interchangeably with MaintenanceType, this enum contains the known values that the service supports. Known values supported by the service PlannedMaintenance: A planned maintenance event.
MicrosoftEntraAuthenticationName	The name of the Microsoft Entra authentication method. KnownMicrosoftEntraAuthenticationName can be used interchangeably with MicrosoftEntraAuthenticationName, this enum contains the known values that the service supports. Known values supported by the service microsoftEntra: Microsoft Entra authentication.
NodeRole	The role performed by a node within its HorizonDB pool. KnownNodeRole can be used interchangeably with NodeRole, this enum contains the known values that the service supports. Known values supported by the service ReadWrite: The node accepts read and write traffic for its cluster. ReadOnly: The node accepts read-only traffic. Unassigned: The node is not currently assigned a read-write or read-only role.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ParameterApplyMethod	Controls when dynamic parameter changes become effective. Static parameter changes always become effective only after a customer-initiated pool Restart. Stop followed by Start and scheduled maintenance do not apply pending parameter changes. KnownParameterApplyMethod can be used interchangeably with ParameterApplyMethod, this enum contains the known values that the service supports. Known values supported by the service Immediate: Apply dynamic parameter changes immediately. Static parameter changes remain pending until a customer-initiated pool Restart. PendingReboot: Keep dynamic and static parameter changes pending until a customer-initiated pool Restart. Stop followed by Start and scheduled maintenance do not apply them.
ParameterGroupSyncStatus	Indicates synchronization status between a HorizonDB resource and its parameter group. KnownParameterGroupSyncStatus can be used interchangeably with ParameterGroupSyncStatus, this enum contains the known values that the service supports. Known values supported by the service Applying: Parameter updates are currently being applied. InSync: Parameter values are synchronized and up to date. FailedToApply: Applying parameter updates failed. PendingReboot: Parameter updates are pending and require a customer-initiated pool Restart to take effect. Stop followed by Start and scheduled maintenance preserve this status.
ParameterValueSource	The source of the effective value assigned to a HorizonDB parameter. KnownParameterValueSource can be used interchangeably with ParameterValueSource, this enum contains the known values that the service supports. Known values supported by the service SystemDefault: The effective value is the system-defined default. UserOverride: The effective value was explicitly supplied by the user, even when it equals the system-defined default value.
PasswordAuthenticationName	The name of the PostgreSQL username-and-password authentication method. KnownPasswordAuthenticationName can be used interchangeably with PasswordAuthenticationName, this enum contains the known values that the service supports. Known values supported by the service passwordMethod: PostgreSQL username-and-password authentication.
PoolComputeModelType	The compute model type. KnownPoolComputeModelType can be used interchangeably with PoolComputeModelType, this enum contains the known values that the service supports. Known values supported by the service Provisioned: Provisioned compute model
PoolHighAvailabilityMode	The high-availability mode requested for a HorizonDB pool. KnownPoolHighAvailabilityMode can be used interchangeably with PoolHighAvailabilityMode, this enum contains the known values that the service supports. Known values supported by the service Disabled: High availability is disabled. This mode is valid only when nodeCount is 1. AnyZone: The service may allocate nodes in the same availability zone or across availability zones. This mode is valid only when nodeCount is 2 through 16. ZoneRedundant: The service must allocate nodes across availability zones. This mode is valid only when nodeCount is 2 through 16.
PoolState	Current state of a HorizonDB pool. KnownPoolState can be used interchangeably with PoolState, this enum contains the known values that the service supports. Known values supported by the service Ready: Is ready and operational Provisioning: Is provisioning Deleting: Is being deleted Inaccessible: Is inaccessible Updating: Is being updated Starting: Is starting up Restarting: Is restarting Stopping: Is stopping Stopped: Is stopped
PostgreSqlCapabilityVersion	A PostgreSQL major version advertised by the HorizonDB capabilities API. KnownPostgreSqlCapabilityVersion can be used interchangeably with PostgreSqlCapabilityVersion, this enum contains the known values that the service supports. Known values supported by the service 17: PostgreSQL major version 17. 18: PostgreSQL major version 18.
PostgreSqlVersion	A PostgreSQL major version supported by HorizonDB. API version 2026-10-01-preview accepts 17 and 18. Future API versions may add named values, and clients must tolerate unknown values returned by the service. KnownPostgreSqlVersion can be used interchangeably with PostgreSqlVersion, this enum contains the known values that the service supports. Known values supported by the service 17: PostgreSQL major version 17. 18: PostgreSQL major version 18.
PrincipalTypes	The type of Microsoft Entra principal mapped to a PostgreSQL role. KnownPrincipalTypes can be used interchangeably with PrincipalTypes, this enum contains the known values that the service supports. Known values supported by the service Unknown: An unknown or unrecognized type. This value is for internal use and is not accepted in requests. User: A Microsoft Entra ID user account. Group: A Microsoft Entra ID security group. All members of the group inherit administrator privileges. ServicePrincipal: A Microsoft Entra ID application or service principal used for automated workloads.
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Connection has been provisioned Creating: Connection is being created Deleting: Connection is being deleted Failed: Connection provisioning has failed
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Connection waiting for approval or rejection Approved: Connection approved Rejected: Connection Rejected
ProvisioningState	The provisioning state. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. InProgress: The HorizonDB resource operation is actively running. Provisioning: The HorizonDB resource is still provisioning.
PublicNetworkAccessState	Indicates if public network access is enabled or not. KnownPublicNetworkAccessState can be used interchangeably with PublicNetworkAccessState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Public network access is enabled Disabled: Public network access is disabled
ScheduledMaintenanceManagementType	Specifies who manages scheduled maintenance for a HorizonDB pool. KnownScheduledMaintenanceManagementType can be used interchangeably with ScheduledMaintenanceManagementType, this enum contains the known values that the service supports. Known values supported by the service System: Scheduled maintenance is managed by the system.
ScheduledMaintenancePropertiesUnion	Alias for ScheduledMaintenancePropertiesUnion

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAiModelManagementStatus	The AI Model Management status for a HorizonDB cluster.
KnownAuthenticationName	The name of a service-created authentication configuration.
KnownAuthenticationState	Indicates if authentication state is enabled or not.
KnownChangeDataCaptureDesiredState	The requested state of a HorizonDB change data capture capability, destination, or configuration.
KnownChangeDataCaptureDestinationEffectiveState	The effective state of a HorizonDB change data capture destination.
KnownChangeDataCaptureDestinationType	The destination type supported by this API version.
KnownChangeDataCaptureEffectiveState	The effective state of a HorizonDB change data capture capability or configuration.
KnownChangeDataCaptureEngineConfigurationState	The readiness of HorizonDB engine settings required for change data capture.
KnownChangeDataCaptureExtensionState	The lifecycle state of the HorizonDB change data capture extension.
KnownChangeDataCaptureIdentityActivationState	The activation state of a change data capture identity assignment.
KnownChangeDataCaptureIdentityAssignmentState	The lifecycle state of a change data capture identity assignment.
KnownChangeDataCaptureIdentityValidationState	The validation state of a change data capture identity assignment.
KnownChangeDataCaptureProtocol	The protocol used to communicate with a change data capture destination.
KnownChangeDataCaptureReadWriteEndpointState	The availability of a read-write endpoint for change data capture engine mutations.
KnownChangeDataCaptureReplicationArchitecture	The implementation architecture used to capture and publish changes.
KnownChangeDataCaptureReplicationState	The state of a destination-owned replication session.
KnownChangeDataCaptureTopologyBindingState	The relationship of a change data capture configuration to the current writer topology.
KnownChangeDataCaptureUsageProfile	The reason that a change data capture configuration exists.
KnownClusterCreateMode	Controls how a HorizonDB cluster PUT request is processed.
KnownClusterState	Current state of a HorizonDB cluster.
KnownComputeProcessorType	The compute processor type.
KnownCreatedByType	The kind of entity that created the resource.
KnownEndpointRole	Role of the endpoint.
KnownEndpointScope	The scope of a HorizonDB endpoint.
KnownGeoRedundancyState	Indicates the geo-redundancy state.
KnownHorizonDbClusterDataEncryptionType	The type of data encryption used by a HorizonDB cluster. The type is selected at cluster creation; switching between SystemManaged and AzureKeyVault after creation is not supported.
KnownHorizonDbClusterEncryptionKeyStatus	The validation status of a customer-managed encryption key used by a HorizonDB cluster.
KnownHorizonDbClusterIdentityType	The managed identity types supported by a HorizonDB cluster.
KnownLogCaptureState	Specifies whether HorizonDB captures log files.
KnownLogFileType	The type of a captured HorizonDB log file.
KnownMaintenanceEventStatus	The status of a maintenance event.
KnownMaintenanceType	The type of a maintenance event.
KnownMicrosoftEntraAuthenticationName	The name of the Microsoft Entra authentication method.
KnownNodeRole	The role performed by a node within its HorizonDB pool.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownParameterApplyMethod	Controls when dynamic parameter changes become effective. Static parameter changes always become effective only after a customer-initiated pool Restart. Stop followed by Start and scheduled maintenance do not apply pending parameter changes.
KnownParameterGroupSyncStatus	Indicates synchronization status between a HorizonDB resource and its parameter group.
KnownParameterValueSource	The source of the effective value assigned to a HorizonDB parameter.
KnownPasswordAuthenticationName	The name of the PostgreSQL username-and-password authentication method.
KnownPoolComputeModelType	The compute model type.
KnownPoolHighAvailabilityMode	The high-availability mode requested for a HorizonDB pool.
KnownPoolState	Current state of a HorizonDB pool.
KnownPostgreSqlCapabilityVersion	A PostgreSQL major version advertised by the HorizonDB capabilities API.
KnownPostgreSqlVersion	A PostgreSQL major version supported by HorizonDB. API version 2026-10-01-preview accepts 17 and 18. Future API versions may add named values, and clients must tolerate unknown values returned by the service.
KnownPrincipalTypes	The type of Microsoft Entra principal mapped to a PostgreSQL role.
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	The provisioning state.
KnownPublicNetworkAccessState	Indicates if public network access is enabled or not.
KnownScheduledMaintenanceManagementType	Specifies who manages scheduled maintenance for a HorizonDB pool.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(HorizonDbClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(HorizonDbClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: HorizonDbClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

HorizonDbClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor