@azure/arm-horizondb package

Classes

Interfaces

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.
HorizonDbAdministrator	Represents an Entra ID administrator configured on a HorizonDB cluster.
HorizonDbAdministratorAdd	The request body for adding a HorizonDB administrator.
HorizonDbAdministratorProperties	Properties of a HorizonDB administrator.
HorizonDbAdministratorPropertiesForAdd	The properties for adding a HorizonDB administrator.
HorizonDbAdministratorsCreateOrUpdateOptionalParams	Optional parameters.
HorizonDbAdministratorsDeleteOptionalParams	Optional parameters.
HorizonDbAdministratorsGetOptionalParams	Optional parameters.
HorizonDbAdministratorsListOptionalParams	Optional parameters.
HorizonDbAdministratorsOperations	Interface representing a HorizonDbAdministrators operations.
HorizonDbClientOptionalParams	Optional parameters for the client.
HorizonDbCluster	Represents the HorizonDB cluster.
HorizonDbClusterAuthConfig	Authentication configuration for a HorizonDB cluster.
HorizonDbClusterForPatchUpdate	HorizonDB cluster for update operations.
HorizonDbClusterMirroring	Mirroring configuration for a HorizonDB cluster.
HorizonDbClusterParameterGroupConnectionProperties	Connection information for HorizonDB parameter group.
HorizonDbClusterProperties	Properties of a HorizonDB cluster.
HorizonDbClusterPropertiesForPatchUpdate	Properties of a HorizonDB cluster for update operations.
HorizonDbClustersCreateOrUpdateOptionalParams	Optional parameters.
HorizonDbClustersDeleteOptionalParams	Optional parameters.
HorizonDbClustersGetOptionalParams	Optional parameters.
HorizonDbClustersListByResourceGroupOptionalParams	Optional parameters.
HorizonDbClustersListBySubscriptionOptionalParams	Optional parameters.
HorizonDbClustersOperations	Interface representing a HorizonDbClusters operations.
HorizonDbClustersRestartOptionalParams	Optional parameters.
HorizonDbClustersStartOptionalParams	Optional parameters.
HorizonDbClustersStopOptionalParams	Optional parameters.
HorizonDbClustersUpdateOptionalParams	Optional parameters.
HorizonDbComputeModel	The compute model for a HorizonDB cluster.
HorizonDbFirewallRule	Represents the HorizonDB firewall rule.
HorizonDbFirewallRuleProperties	Properties of a HorizonDB firewall rule.
HorizonDbFirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
HorizonDbFirewallRulesDeleteOptionalParams	Optional parameters.
HorizonDbFirewallRulesGetOptionalParams	Optional parameters.
HorizonDbFirewallRulesListOptionalParams	Optional parameters.
HorizonDbFirewallRulesOperations	Interface representing a HorizonDbFirewallRules operations.
HorizonDbParameterGroup	Represents the HorizonDB parameter group.
HorizonDbParameterGroupConnectionProperties	Connection information for HorizonDB parameter group.
HorizonDbParameterGroupForPatchUpdate	HorizonDB parameter group for update operations.
HorizonDbParameterGroupProperties	Properties of a HorizonDB parameter group.
HorizonDbParameterGroupPropertiesForPatchUpdate	Properties of a HorizonDB parameter group for update operations.
HorizonDbParameterGroupsCreateOrUpdateOptionalParams	Optional parameters.
HorizonDbParameterGroupsDeleteOptionalParams	Optional parameters.
HorizonDbParameterGroupsGetOptionalParams	Optional parameters.
HorizonDbParameterGroupsListByResourceGroupOptionalParams	Optional parameters.
HorizonDbParameterGroupsListBySubscriptionOptionalParams	Optional parameters.
HorizonDbParameterGroupsListConnectionsOptionalParams	Optional parameters.
HorizonDbParameterGroupsListVersionsOptionalParams	Optional parameters.
HorizonDbParameterGroupsOperations	Interface representing a HorizonDbParameterGroups operations.
HorizonDbParameterGroupsUpdateOptionalParams	Optional parameters.
HorizonDbPool	Represents the HorizonDB pool.
HorizonDbPoolProperties	Properties of a HorizonDB pool.
HorizonDbPoolsGetOptionalParams	Optional parameters.
HorizonDbPoolsListOptionalParams	Optional parameters.
HorizonDbPoolsOperations	Interface representing a HorizonDbPools operations.
HorizonDbPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
HorizonDbPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
HorizonDbPrivateEndpointConnectionsListOptionalParams	Optional parameters.
HorizonDbPrivateEndpointConnectionsOperations	Interface representing a HorizonDbPrivateEndpointConnections operations.
HorizonDbPrivateEndpointConnectionsUpdateStatusOptionalParams	Optional parameters.
HorizonDbPrivateLinkResource	Represents the HorizonDB private link resource.
HorizonDbPrivateLinkResourcesGetOptionalParams	Optional parameters.
HorizonDbPrivateLinkResourcesListOptionalParams	Optional parameters.
HorizonDbPrivateLinkResourcesOperations	Interface representing a HorizonDbPrivateLinkResources operations.
HorizonDbReplica	Represents the HorizonDB replica.
HorizonDbReplicaForPatchUpdate	HorizonDB replica for update operations.
HorizonDbReplicaProperties	Properties of a HorizonDB replica.
HorizonDbReplicaPropertiesForPatchUpdate	Properties of a HorizonDB replica for update operations.
HorizonDbReplicasCreateOrUpdateOptionalParams	Optional parameters.
HorizonDbReplicasDeleteOptionalParams	Optional parameters.
HorizonDbReplicasGetOptionalParams	Optional parameters.
HorizonDbReplicasListOptionalParams	Optional parameters.
HorizonDbReplicasOperations	Interface representing a HorizonDbReplicas operations.
HorizonDbReplicasUpdateOptionalParams	Optional parameters.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Network	Network properties.
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.
ParameterProperties	Properties of a HorizonDB parameters.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionResource	A private endpoint connection resource
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
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.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	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.
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
ContinuablePage	An interface that describes a page of results.
CreateModeCluster	The mode to create a new HorizonDB cluster. KnownCreateModeCluster can be used interchangeably with CreateModeCluster, this enum contains the known values that the service supports. Known values supported by the service Create: Create a new cluster Update: Update an existing cluster PointInTimeRestore: Create cluster from point-in-time restore
CreateModePool	The mode to create a new HorizonDB cluster. KnownCreateModePool can be used interchangeably with CreateModePool, this enum contains the known values that the service supports. Known values supported by the service Create: Create a new pool Update: Update an existing pool
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.
HorizonDbComputeModelType	The compute model type. KnownHorizonDbComputeModelType can be used interchangeably with HorizonDbComputeModelType, this enum contains the known values that the service supports. Known values supported by the service Provisioned: Provisioned compute. Serverless: Serverless compute.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
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.
PrincipalTypes	The type of the Entra ID principal. KnownPrincipalTypes can be used interchangeably with PrincipalTypes, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown or unrecognized type (internal only, not accepted in requests). User: An Entra ID user account (UPN-based principal). Group: An Entra ID security group. All members of the group inherit admin privileges. ServicePrincipal: An Entra ID application / 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: Provisioning completed successfully Failed: Provisioning failed Canceled: Provisioning was canceled InProgress: Provisioning is in progress Provisioning: Provisioning is in progress
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
ReplicaRole	Role of the replica. KnownReplicaRole can be used interchangeably with ReplicaRole, this enum contains the known values that the service supports. Known values supported by the service Read: Read-only replica ReadWrite: ReadWrite replica
State	Current states. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service Ready: Is ready and operational Dropping: Is being dropped/deleted Disabled: Is disabled Starting: Is starting up Stopping: Is stopping Stopped: Is stopped Updating: Is being updated Healthy: Is healthy Succeeded: Is succeeded Upgrading: Is upgrading
ZonePlacementPolicy	The zone redundancy option for the cluster. KnownZonePlacementPolicy can be used interchangeably with ZonePlacementPolicy, this enum contains the known values that the service supports. Known values supported by the service Strict: Enforce zonal redundancy BestEffort: Best-effort placement (default)

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.
KnownAuthenticationState	Indicates if authentication state is enabled or not.
KnownCreateModeCluster	The mode to create a new HorizonDB cluster.
KnownCreateModePool	The mode to create a new HorizonDB cluster.
KnownCreatedByType	The kind of entity that created the resource.
KnownHorizonDbComputeModelType	The compute model type.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPrincipalTypes	The type of the Entra ID principal.
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.
KnownReplicaRole	Role of the replica.
KnownState	Current states.
KnownVersions	The available API versions.
KnownZonePlacementPolicy	The zone redundancy option for the cluster.

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.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

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>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-horizondb package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

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

Parameters

Returns

Variable Details

RestError

Type

Feedback