@azure/arm-postgresqlhsc package

Classes

Interfaces

AuthConfig	Authentication configuration of a cluster.
Cluster	Represents a cluster.
ClusterForUpdate	Represents a cluster for update.
ClusterProperties	Properties of the cluster.
ClusterPropertiesForUpdate	The properties used to update a cluster.
ClusterServer	Represents a server in a cluster.
ClusterServerProperties	The properties of a server in cluster.
ClustersCheckNameAvailabilityOptionalParams	Optional parameters.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ClustersPromoteReadReplicaOptionalParams	Optional parameters.
ClustersRestartOptionalParams	Optional parameters.
ClustersStartOptionalParams	Optional parameters.
ClustersStopOptionalParams	Optional parameters.
ClustersUpdateOptionalParams	Optional parameters.
Configuration	Represents configuration details for coordinator and node.
ConfigurationProperties	The properties of configuration.
ConfigurationsGetCoordinatorOptionalParams	Optional parameters.
ConfigurationsGetNodeOptionalParams	Optional parameters.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListByClusterOptionalParams	Optional parameters.
ConfigurationsListByServerOptionalParams	Optional parameters.
ConfigurationsOperations	Interface representing a Configurations operations.
ConfigurationsUpdateOnCoordinatorOptionalParams	Optional parameters.
ConfigurationsUpdateOnNodeOptionalParams	Optional parameters.
DBforPostgreSQLClientOptionalParams	Optional parameters for the client.
DataEncryption	The data encryption properties of a cluster.
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.
FirewallRule	Represents a cluster firewall rule.
FirewallRuleProperties	The properties of a cluster firewall rule.
FirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListByClusterOptionalParams	Optional parameters.
FirewallRulesOperations	Interface representing a FirewallRules operations.
IdentityProperties	Describes the identity of the cluster.
MaintenanceWindow	Schedule settings for regular cluster updates.
NameAvailability	Represents cluster name availability.
NameAvailabilityRequest	Request from client to check cluster name availability.
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.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	A private endpoint connection resource
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionSimpleProperties	The properties in private endpoint connection
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByClusterOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateEndpointProperty	Property to represent resource id of the private endpoint.
PrivateLinkResource	A private link resource.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByClusterOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
PromoteRequest	Request from client to promote geo-redundant replica
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
Role	Represents a cluster role.
RoleProperties	The properties of a cluster role.
RolePropertiesExternalIdentity	model interface RolePropertiesExternalIdentity
RolesCreateOptionalParams	Optional parameters.
RolesDeleteOptionalParams	Optional parameters.
RolesGetOptionalParams	Optional parameters.
RolesListByClusterOptionalParams	Optional parameters.
RolesOperations	Interface representing a Roles operations.
ServerConfiguration	Represents a configuration.
ServerConfigurationProperties	The properties of a configuration.
ServerNameItem	The name object for a server.
ServerProperties	The properties of a server.
ServerRoleGroupConfiguration	Represents server role group configuration value.
ServersGetOptionalParams	Optional parameters.
ServersListByClusterOptionalParams	Optional parameters.
ServersOperations	Interface representing a Servers operations.
SimplePrivateEndpointConnection	A private endpoint connection.
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

AadEnabledEnum	Indicates whether the cluster was created using AAD authentication. KnownAadEnabledEnum can be used interchangeably with AadEnabledEnum, this enum contains the known values that the service supports. Known values supported by the service enabled disabled
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.
ActiveDirectoryAuth	Type of ActiveDirectoryAuth
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CheckNameAvailabilityResourceType	Resource type used for name availability verification.
ConfigurationDataType	Data type of the configuration. KnownConfigurationDataType can be used interchangeably with ConfigurationDataType, this enum contains the known values that the service supports. Known values supported by the service Boolean Numeric Integer Enumeration
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.
DataEncryptionType	Type of DataEncryptionType
IdentityType	Type of IdentityType
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.
PasswordAuth	Type of PasswordAuth
PasswordEnabledEnum	Indicates whether the cluster was created with a password or using AAD authentication. KnownPasswordEnabledEnum can be used interchangeably with PasswordEnabledEnum, this enum contains the known values that the service supports. Known values supported by the service enabled disabled
PrincipalType	Type of PrincipalType
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 current 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 Canceled InProgress Failed
RoleType	Type of RoleType
ServerRole	The role of a server. KnownServerRole can be used interchangeably with ServerRole, this enum contains the known values that the service supports. Known values supported by the service Coordinator Worker

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAadEnabledEnum	Indicates whether the cluster was created using AAD authentication.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActiveDirectoryAuth	Known values of ActiveDirectoryAuth that the service accepts.
KnownConfigurationDataType	Data type of the configuration.
KnownCreatedByType	The kind of entity that created the resource.
KnownDataEncryptionType	Known values of DataEncryptionType that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPasswordAuth	Known values of PasswordAuth that the service accepts.
KnownPasswordEnabledEnum	Indicates whether the cluster was created with a password or using AAD authentication.
KnownPrincipalType	Known values of PrincipalType that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	The current provisioning state.
KnownRoleType	Known values of RoleType that the service accepts.
KnownServerRole	The role of a server.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(DBforPostgreSQLClient, 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>(DBforPostgreSQLClient, 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: DBforPostgreSQLClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: DBforPostgreSQLClient

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-postgresqlhsc 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

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

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

Parameters

Returns

Variable Details

RestError

Type

Feedback