@azure/arm-neonpostgres package

Reference

Classes

Interfaces

Attributes	Additional attributes specific to Neon Resources
Branch	The Branch resource type.
BranchProperties	Properties specific to Branch
BranchesCreateOrUpdateOptionalParams	Optional parameters.
BranchesDeleteOptionalParams	Optional parameters.
BranchesGetOptionalParams	Optional parameters.
BranchesListOptionalParams	Optional parameters.
BranchesOperations	Interface representing a Branches operations.
BranchesUpdateOptionalParams	Optional parameters.
CompanyDetails	Company details for an organization
Compute	The Compute resource type.
ComputeProperties	Properties specific to Compute
ComputesCreateOrUpdateOptionalParams	Optional parameters.
ComputesDeleteOptionalParams	Optional parameters.
ComputesGetOptionalParams	Optional parameters.
ComputesListOptionalParams	Optional parameters.
ComputesOperations	Interface representing a Computes operations.
ComputesUpdateOptionalParams	Optional parameters.
ConnectionUriProperties	Connection uri parameters for the associated database
DefaultEndpointSettings	Default Endpoint Settings for the project.
Endpoint	The Neon compute endpoint resource type.
EndpointProperties	Properties specific to Endpoints
EndpointsCreateOrUpdateOptionalParams	Optional parameters.
EndpointsDeleteOptionalParams	Optional parameters.
EndpointsGetOptionalParams	Optional parameters.
EndpointsListOptionalParams	Optional parameters.
EndpointsOperations	Interface representing a Endpoints operations.
EndpointsUpdateOptionalParams	Optional parameters.
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.
MarketplaceDetails	Marketplace details for an organization
NeonDatabase	The Neon Database resource type.
NeonDatabaseProperties	Properties specific to Databases
NeonDatabasesCreateOrUpdateOptionalParams	Optional parameters.
NeonDatabasesDeleteOptionalParams	Optional parameters.
NeonDatabasesGetOptionalParams	Optional parameters.
NeonDatabasesListOptionalParams	Optional parameters.
NeonDatabasesOperations	Interface representing a NeonDatabases operations.
NeonDatabasesUpdateOptionalParams	Optional parameters.
NeonRole	The Neon Role resource type.
NeonRoleProperties	Properties specific to Roles
NeonRolesCreateOrUpdateOptionalParams	Optional parameters.
NeonRolesDeleteOptionalParams	Optional parameters.
NeonRolesGetOptionalParams	Optional parameters.
NeonRolesListOptionalParams	Optional parameters.
NeonRolesOperations	Interface representing a NeonRoles operations.
NeonRolesUpdateOptionalParams	Optional parameters.
OfferDetails	Offer details for the marketplace that is selected by the user
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for and operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OrganizationProperties	Properties specific to Neon Organization resource
OrganizationResource	Organization Resource by Neon
OrganizationsCreateOrUpdateOptionalParams	Optional parameters.
OrganizationsDeleteOptionalParams	Optional parameters.
OrganizationsGetOptionalParams	Optional parameters.
OrganizationsGetPostgresVersionsOptionalParams	Optional parameters.
OrganizationsListByResourceGroupOptionalParams	Optional parameters.
OrganizationsListBySubscriptionOptionalParams	Optional parameters.
OrganizationsOperations	Interface representing a Organizations operations.
OrganizationsUpdateOptionalParams	Optional parameters.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PartnerOrganizationProperties	Properties specific to Partner's organization
PgVersion	PostgreSQL Version model
PgVersionsResult	Response model for PostgreSQL versions
PostgresClientOptionalParams	Optional parameters for the client.
Project	The Project resource type.
ProjectProperties	Properties specific to Project
ProjectsCreateOrUpdateOptionalParams	Optional parameters.
ProjectsDeleteOptionalParams	Optional parameters.
ProjectsGetConnectionUriOptionalParams	Optional parameters.
ProjectsGetOptionalParams	Optional parameters.
ProjectsListOptionalParams	Optional parameters.
ProjectsOperations	Interface representing a Projects operations.
ProjectsUpdateOptionalParams	Optional parameters.
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
SingleSignOnProperties	Properties specific to Single Sign On Resource
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'
UserDetails	User details for an organization

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.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref: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.
EndpointType	The compute endpoint type. Either read_write or read_only. KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports. Known values supported by the service read_only: ReadOnly compute endpoint type read_write: ReadWrite compute endpoint type
MarketplaceSubscriptionStatus	Marketplace subscription status of a resource. KnownMarketplaceSubscriptionStatus can be used interchangeably with MarketplaceSubscriptionStatus, this enum contains the known values that the service supports. Known values supported by the service PendingFulfillmentStart: Purchased but not yet activated Subscribed: Marketplace subscription is activated Suspended: This state indicates that a customer's payment for the Marketplace service was not received Unsubscribed: Customer has cancelled the subscription
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.
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, 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.
SingleSignOnStates	Various states of the SSO resource KnownSingleSignOnStates can be used interchangeably with SingleSignOnStates, this enum contains the known values that the service supports. Known values supported by the service Initial: Initial state of the SSO resource Enable: SSO is enabled for the organization Disable: SSO is disabled for the organization

Enums

KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownEndpointType	The compute endpoint type. Either read_write or read_only.
KnownMarketplaceSubscriptionStatus	Marketplace subscription status of a resource.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownSingleSignOnStates	Various states of the SSO resource
KnownVersions	Supported API versions for the Neon.Postgres resource provider.

Functions

restorePoller<TResponse, TResult>(PostgresClient, 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 Details

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

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

Parameters

client: PostgresClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Share via

@azure/arm-neonpostgres 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

Enums

Functions

Function Details

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

Parameters

Returns