@azure/arm-neonpostgres package

Classes

PostgresClient

Interfaces

CompanyDetails	Company details for an organization
MarketplaceDetails	Marketplace details for an organization
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 Data Organization resource
OrganizationResource	Organization Resource by Neon
OrganizationsCreateOrUpdateOptionalParams	Optional parameters.
OrganizationsDeleteOptionalParams	Optional parameters.
OrganizationsGetOptionalParams	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
PostgresClientOptionalParams	Optional parameters for the client.
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.
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.
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>)

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