@azure/arm-pineconevectordb package
Classes
| VectorDbClient |
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. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| 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 Organization |
| OrganizationResource |
Concrete tracked resource types can be created by aliasing this type using a specific property type. |
| OrganizationResourceUpdate |
The type used for update operations of the Organization Resource. |
| 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. |
| PartnerProperties |
Partner's specific Properties |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RestorePollerOptions | |
| SingleSignOnPropertiesV2 |
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' |
| UserAssignedIdentity |
User assigned identity properties |
| UserDetails |
User details for an organization |
| VectorDbClientOptionalParams |
Optional parameters for the client. |
Type Aliases
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| MarketplaceSubscriptionStatus |
Marketplace subscription status of a resource. Known values supported by the servicePendingFulfillmentStart: Purchased but not yet activated |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| ResourceProvisioningState |
The provisioning state of a resource type. Known values supported by the serviceSucceeded: Resource has been created. |
| SingleSignOnStates |
Various states of the SSO resource Known values supported by the serviceInitial: Initial state of the SSO resource |
| SingleSignOnType |
Defines the type of Single Sign-On (SSO) mechanism being used Known values supported by the serviceSaml: Security Assertion Markup Language (SAML) based Single Sign-On |
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. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| 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 |
| KnownSingleSignOnType |
Defines the type of Single Sign-On (SSO) mechanism being used |
| KnownVersions |
The available API versions. |
Functions
| restore |
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>(VectorDbClient, 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: VectorDbClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- VectorDbClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>