@azure/arm-cosmosdb 16.3.0 → 16.4.0-alpha.20251117.1

package/dist/browser/models/index.d.ts

@@ -1,4 +1,4 @@
-import * as coreClient from "@azure/core-client";
+import type * as coreClient from "@azure/core-client";
 export type BackupPolicyUnion = BackupPolicy | PeriodicModeBackupPolicy | ContinuousModeBackupPolicy;
 export type ServiceResourcePropertiesUnion = ServiceResourceProperties | DataTransferServiceResourceProperties | SqlDedicatedGatewayServiceResourceProperties | GraphAPIComputeServiceResourceProperties | MaterializedViewsBuilderServiceResourceProperties;
 export type ServiceResourceCreateUpdatePropertiesUnion = ServiceResourceCreateUpdateProperties | DataTransferServiceResourceCreateUpdateProperties | SqlDedicatedGatewayServiceResourceCreateUpdateProperties | GraphAPIComputeServiceResourceCreateUpdateProperties | MaterializedViewsBuilderServiceResourceCreateUpdateProperties;
@@ -339,6 +339,10 @@ export interface DatabaseAccountUpdateParameters {
     customerManagedKeyStatus?: string;
     /** Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account */
     enablePerRegionPerPartitionAutoscale?: boolean;
+    /** Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account */
+    enablePriorityBasedExecution?: boolean;
+    /** Enum to indicate default Priority Level of request for Priority Based Execution. */
+    defaultPriorityLevel?: DefaultPriorityLevel;
 }
 /** The list of new failover policies for the failover priority change. */
 export interface FailoverPolicies {
@@ -861,6 +865,8 @@ export interface IndexingPolicy {
     spatialIndexes?: SpatialSpec[];
     /** List of paths to include in the vector indexing */
     vectorIndexes?: VectorIndex[];
+    /** List of paths to include in the full text indexing */
+    fullTextIndexes?: FullTextIndexPath[];
 }
 /** The paths that are included in indexing */
 export interface IncludedPath {
@@ -899,6 +905,17 @@ export interface VectorIndex {
     path: string;
     /** The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. */
     type: VectorIndexType;
+    /** The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types. */
+    quantizationByteSize?: number;
+    /** This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type. */
+    indexingSearchListSize?: number;
+    /** Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types. */
+    vectorIndexShardKey?: string[];
+}
+/** Represents the full text index path. */
+export interface FullTextIndexPath {
+    /** The path to the full text field in the document. */
+    path: string;
 }
 /** The configuration of the partition key to be used for partitioning data into multiple partitions */
 export interface ContainerPartitionKey {
@@ -2438,6 +2455,100 @@ export interface ServiceResourceCreateUpdateProperties {
     /** Instance count for the service. */
     instanceCount?: number;
 }
+/** The response of the List operation that contains the fleets and their properties. */
+export interface FleetListResult {
+    /**
+     * List of fleets and their properties.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: FleetResource[];
+    /**
+     * The link used to get the next page of results.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface ResourceAutoGenerated {
+    /**
+     * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The name of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+}
+/** Represents a fleet resource for updates. */
+export interface FleetResourceUpdate {
+    /** A provisioning state of the Fleet. */
+    provisioningState?: Status;
+}
+/** The response of the List operation that contains the fleetspaces and their properties. */
+export interface FleetspaceListResult {
+    /**
+     * List of fleetspaces and their properties.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: FleetspaceResource[];
+    /**
+     * The link used to get the next page of results.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+/** Configuration for throughput pool in the fleetspace. */
+export interface FleetspacePropertiesThroughputPoolConfiguration {
+    /** Minimum throughput for the pool. */
+    minThroughput?: number;
+    /** Maximum throughput for the pool. */
+    maxThroughput?: number;
+}
+/** Represents a fleetspace resource for updates. */
+export interface FleetspaceUpdate {
+    /** A provisioning state of the Fleetspace. */
+    provisioningState?: Status;
+    /** The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' */
+    fleetspaceApiKind?: FleetspacePropertiesFleetspaceApiKind;
+    /** Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. */
+    serviceTier?: FleetspacePropertiesServiceTier;
+    /** List of data regions assigned to the fleetspace. Eg [westus2] */
+    dataRegions?: string[];
+    /** Configuration for throughput pool in the fleetspace. */
+    throughputPoolConfiguration?: FleetspacePropertiesThroughputPoolConfiguration;
+}
+/** The List operation response, that contains the global database accounts and their properties. */
+export interface FleetspaceAccountListResult {
+    /**
+     * List of global database accounts in a fleetspace and their properties.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: FleetspaceAccountResource[];
+    /**
+     * The link used to get the next page of results.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+/** Configuration for fleetspace Account in the fleetspace. */
+export interface FleetspaceAccountPropertiesGlobalDatabaseAccountProperties {
+    /** The resource identifier of global database account in the Fleetspace Account. */
+    resourceId?: string;
+    /** The location of  global database account in the Fleetspace Account. */
+    armLocation?: string;
+}
 /** Configuration values for periodic mode backup */
 export interface PeriodicModeProperties {
     /** An integer representing the interval in minutes between two backups */
@@ -2503,6 +2614,8 @@ export interface RestoreParameters extends RestoreParametersBase {
     gremlinDatabasesToRestore?: GremlinDatabaseRestoreResource[];
     /** List of specific tables available for restore. */
     tablesToRestore?: string[];
+    /** The source backup location for restore. */
+    sourceBackupLocation?: string;
 }
 /** Parameters to indicate the information about the restore. */
 export interface ResourceRestoreParameters extends RestoreParametersBase {
@@ -2642,6 +2755,15 @@ export interface DatabaseAccountGetResults extends ARMResourceProperties {
     customerManagedKeyStatus?: string;
     /** Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account */
     enablePerRegionPerPartitionAutoscale?: boolean;
+    /**
+     * The version of the Customer Managed Key currently being used by the account
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly keyVaultKeyUriVersion?: string;
+    /** Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account */
+    enablePriorityBasedExecution?: boolean;
+    /** Enum to indicate default Priority Level of request for Priority Based Execution. */
+    defaultPriorityLevel?: DefaultPriorityLevel;
 }
 /** Parameters to create and update Cosmos DB database accounts. */
 export interface DatabaseAccountCreateUpdateParameters extends ARMResourceProperties {
@@ -2718,6 +2840,10 @@ export interface DatabaseAccountCreateUpdateParameters extends ARMResourceProper
     customerManagedKeyStatus?: string;
     /** Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account */
     enablePerRegionPerPartitionAutoscale?: boolean;
+    /** Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account */
+    enablePriorityBasedExecution?: boolean;
+    /** Enum to indicate default Priority Level of request for Priority Based Execution. */
+    defaultPriorityLevel?: DefaultPriorityLevel;
 }
 /** An Azure Cosmos DB SQL database. */
 export interface SqlDatabaseGetResults extends ARMResourceProperties {
@@ -3196,6 +3322,18 @@ export interface MaterializedViewsBuilderServiceResourceCreateUpdateProperties e
     /** Polymorphic discriminator, which specifies the different types this object can be */
     serviceType: "MaterializedViewsBuilder";
 }
+/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
+export interface TrackedResource extends ResourceAutoGenerated {
+    /** Resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The geo-location where the resource lives */
+    location: string;
+}
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResourceAutoGenerated extends ResourceAutoGenerated {
+}
 /** Resource for a regional service location. */
 export interface DataTransferRegionalServiceResource extends RegionalServiceResource {
 }
@@ -3229,6 +3367,31 @@ export interface PrivateEndpointConnection extends ProxyResource {
     /** Provisioning state of the private endpoint. */
     provisioningState?: string;
 }
+/** An Azure Cosmos DB FleetResource. */
+export interface FleetResource extends TrackedResource {
+    /** A provisioning state of the Fleet. */
+    provisioningState?: Status;
+}
+/** An Azure Cosmos DB Fleetspace. */
+export interface FleetspaceResource extends ProxyResourceAutoGenerated {
+    /** A provisioning state of the Fleetspace. */
+    provisioningState?: Status;
+    /** The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' */
+    fleetspaceApiKind?: FleetspacePropertiesFleetspaceApiKind;
+    /** Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. */
+    serviceTier?: FleetspacePropertiesServiceTier;
+    /** List of data regions assigned to the fleetspace. Eg [westus2] */
+    dataRegions?: string[];
+    /** Configuration for throughput pool in the fleetspace. */
+    throughputPoolConfiguration?: FleetspacePropertiesThroughputPoolConfiguration;
+}
+/** An Azure Cosmos DB Fleetspace Account */
+export interface FleetspaceAccountResource extends ProxyResourceAutoGenerated {
+    /** A provisioning state of the Fleetspace Account. */
+    provisioningState?: Status;
+    /** Configuration for fleetspace Account in the fleetspace. */
+    globalDatabaseAccountProperties?: FleetspaceAccountPropertiesGlobalDatabaseAccountProperties;
+}
 /** Defines headers for DatabaseAccounts_delete operation. */
 export interface DatabaseAccountsDeleteHeaders {
     /** URI to poll for completion status. */
@@ -3642,6 +3805,34 @@ export interface ServiceDeleteHeaders {
     /** URI to poll for completion status. */
     location?: string;
 }
+/** Defines headers for Fleet_delete operation. */
+export interface FleetDeleteHeaders {
+    /** URI to poll for completion status. */
+    azureAsyncOperation?: string;
+    /** URI to poll for completion status. */
+    location?: string;
+}
+/** Defines headers for Fleetspace_update operation. */
+export interface FleetspaceUpdateHeaders {
+    /** URI to poll for completion status. */
+    azureAsyncOperation?: string;
+    /** URI to poll for completion status. */
+    location?: string;
+}
+/** Defines headers for Fleetspace_delete operation. */
+export interface FleetspaceDeleteHeaders {
+    /** URI to poll for completion status. */
+    azureAsyncOperation?: string;
+    /** URI to poll for completion status. */
+    location?: string;
+}
+/** Defines headers for FleetspaceAccount_delete operation. */
+export interface FleetspaceAccountDeleteHeaders {
+    /** URI to poll for completion status. */
+    azureAsyncOperation?: string;
+    /** URI to poll for completion status. */
+    location?: string;
+}
 /** Known values of {@link DatabaseAccountKind} that the service accepts. */
 export declare enum KnownDatabaseAccountKind {
     /** GlobalDocumentDB */
@@ -3826,6 +4017,22 @@ export declare enum KnownMinimalTlsVersion {
  * **Tls12**
  */
 export type MinimalTlsVersion = string;
+/** Known values of {@link DefaultPriorityLevel} that the service accepts. */
+export declare enum KnownDefaultPriorityLevel {
+    /** High */
+    High = "High",
+    /** Low */
+    Low = "Low"
+}
+/**
+ * Defines values for DefaultPriorityLevel. \
+ * {@link KnownDefaultPriorityLevel} can be used interchangeably with DefaultPriorityLevel,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **High** \
+ * **Low**
+ */
+export type DefaultPriorityLevel = string;
 /** Known values of {@link CreatedByType} that the service accepts. */
 export declare enum KnownCreatedByType {
     /** User */
@@ -4153,7 +4360,9 @@ export declare enum KnownVectorDataType {
     /** Uint8 */
     Uint8 = "uint8",
     /** Int8 */
-    Int8 = "int8"
+    Int8 = "int8",
+    /** Float16 */
+    Float16 = "float16"
 }
 /**
  * Defines values for VectorDataType. \
@@ -4162,7 +4371,8 @@ export declare enum KnownVectorDataType {
  * ### Known values supported by the service
  * **float32** \
  * **uint8** \
- * **int8**
+ * **int8** \
+ * **float16**
  */
 export type VectorDataType = string;
 /** Known values of {@link DistanceFunction} that the service accepts. */
@@ -4255,7 +4465,17 @@ export declare enum KnownStatus {
     /** Online */
     Online = "Online",
     /** Deleting */
-    Deleting = "Deleting"
+    Deleting = "Deleting",
+    /** Creating */
+    Creating = "Creating",
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Updating */
+    Updating = "Updating"
 }
 /**
  * Defines values for Status. \
@@ -4266,7 +4486,12 @@ export declare enum KnownStatus {
  * **Initializing** \
  * **InternallyReady** \
  * **Online** \
- * **Deleting**
+ * **Deleting** \
+ * **Creating** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Updating**
  */
 export type Status = string;
 /** Known values of {@link ManagedCassandraProvisioningState} that the service accepts. */
@@ -4536,6 +4761,35 @@ export declare enum KnownServiceStatus {
  * **Stopped**
  */
 export type ServiceStatus = string;
+/** Known values of {@link FleetspacePropertiesFleetspaceApiKind} that the service accepts. */
+export declare enum KnownFleetspacePropertiesFleetspaceApiKind {
+    /** NoSQL */
+    NoSQL = "NoSQL"
+}
+/**
+ * Defines values for FleetspacePropertiesFleetspaceApiKind. \
+ * {@link KnownFleetspacePropertiesFleetspaceApiKind} can be used interchangeably with FleetspacePropertiesFleetspaceApiKind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **NoSQL**
+ */
+export type FleetspacePropertiesFleetspaceApiKind = string;
+/** Known values of {@link FleetspacePropertiesServiceTier} that the service accepts. */
+export declare enum KnownFleetspacePropertiesServiceTier {
+    /** GeneralPurpose */
+    GeneralPurpose = "GeneralPurpose",
+    /** BusinessCritical */
+    BusinessCritical = "BusinessCritical"
+}
+/**
+ * Defines values for FleetspacePropertiesServiceTier. \
+ * {@link KnownFleetspacePropertiesServiceTier} can be used interchangeably with FleetspacePropertiesServiceTier,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **GeneralPurpose** \
+ * **BusinessCritical**
+ */
+export type FleetspacePropertiesServiceTier = string;
 /** Known values of {@link ContinuousTier} that the service accepts. */
 export declare enum KnownContinuousTier {
     /** Continuous7Days */
@@ -5918,6 +6172,129 @@ export interface ServiceDeleteOptionalParams extends coreClient.OperationOptions
     resumeFrom?: string;
 }
 /** Optional parameters. */
+export interface FleetListOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the list operation. */
+export type FleetListResponse = FleetListResult;
+/** Optional parameters. */
+export interface FleetListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listByResourceGroup operation. */
+export type FleetListByResourceGroupResponse = FleetListResult;
+/** Optional parameters. */
+export interface FleetGetOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the get operation. */
+export type FleetGetResponse = FleetResource;
+/** Optional parameters. */
+export interface FleetCreateOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the create operation. */
+export type FleetCreateResponse = FleetResource;
+/** Optional parameters. */
+export interface FleetUpdateOptionalParams extends coreClient.OperationOptions {
+    /** The parameters to provide for the current fleet. */
+    body?: FleetResourceUpdate;
+}
+/** Contains response data for the update operation. */
+export type FleetUpdateResponse = FleetResource;
+/** Optional parameters. */
+export interface FleetDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the delete operation. */
+export type FleetDeleteResponse = FleetDeleteHeaders;
+/** Optional parameters. */
+export interface FleetListNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listNext operation. */
+export type FleetListNextResponse = FleetListResult;
+/** Optional parameters. */
+export interface FleetListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listByResourceGroupNext operation. */
+export type FleetListByResourceGroupNextResponse = FleetListResult;
+/** Optional parameters. */
+export interface FleetspaceListOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the list operation. */
+export type FleetspaceListResponse = FleetspaceListResult;
+/** Optional parameters. */
+export interface FleetspaceGetOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the get operation. */
+export type FleetspaceGetResponse = FleetspaceResource;
+/** Optional parameters. */
+export interface FleetspaceCreateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the create operation. */
+export type FleetspaceCreateResponse = FleetspaceResource;
+/** Optional parameters. */
+export interface FleetspaceUpdateOptionalParams extends coreClient.OperationOptions {
+    /** The parameters to provide for the current fleetspace. */
+    body?: FleetspaceUpdate;
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the update operation. */
+export type FleetspaceUpdateResponse = FleetspaceResource;
+/** Optional parameters. */
+export interface FleetspaceDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the delete operation. */
+export type FleetspaceDeleteResponse = FleetspaceDeleteHeaders;
+/** Optional parameters. */
+export interface FleetspaceListNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listNext operation. */
+export type FleetspaceListNextResponse = FleetspaceListResult;
+/** Optional parameters. */
+export interface FleetspaceAccountListOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the list operation. */
+export type FleetspaceAccountListResponse = FleetspaceAccountListResult;
+/** Optional parameters. */
+export interface FleetspaceAccountGetOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the get operation. */
+export type FleetspaceAccountGetResponse = FleetspaceAccountResource;
+/** Optional parameters. */
+export interface FleetspaceAccountCreateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the create operation. */
+export type FleetspaceAccountCreateResponse = FleetspaceAccountResource;
+/** Optional parameters. */
+export interface FleetspaceAccountDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the delete operation. */
+export type FleetspaceAccountDeleteResponse = FleetspaceAccountDeleteHeaders;
+/** Optional parameters. */
+export interface FleetspaceAccountListNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listNext operation. */
+export type FleetspaceAccountListNextResponse = FleetspaceAccountListResult;
+/** Optional parameters. */
 export interface CosmosDBManagementClientOptionalParams extends coreClient.ServiceClientOptions {
     /** server parameter */
     $host?: string;