@azure/arm-cosmosdb package
Classes
Interfaces
ARMProxy |
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags |
ARMResource |
The core properties of ARM resources. |
Account |
The metadata related to an access key for a given database account. |
Analytical |
Analytical storage specific properties. |
Api |
|
Authentication |
Ldap authentication method properties. This feature is in preview. |
Auto |
Cosmos DB resource auto-upgrade policy |
Autoscale |
|
Autoscale |
Cosmos DB provisioned throughput settings object |
Backup |
Backup information of a resource. |
Backup |
The object representing the policy for taking backups on an account. |
Backup |
The object representing the state of the migration between the backup policies. |
Capability |
Cosmos DB capability object |
Capacity |
The object that represents all properties related to capacity enforcement on an account. |
Cassandra |
Properties of a managed Cassandra cluster public status. |
Cassandra |
|
Cassandra |
Interface representing a CassandraClusters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Interface representing a CassandraDataCenters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
|
Cassandra |
Parameters to create and update Cosmos DB Cassandra keyspace. |
Cassandra |
Cosmos DB options resource object |
Cassandra |
Cosmos DB Cassandra keyspace resource object |
Cassandra |
An Azure Cosmos DB Cassandra keyspace. |
Cassandra |
The List operation response, that contains the Cassandra keyspaces and their properties. |
Cassandra |
Cosmos DB Cassandra keyspace resource object |
Cassandra |
Cosmos DB Cassandra table partition key |
Cassandra |
Interface representing a CassandraResources. |
Cassandra |
Defines headers for CassandraResources_createUpdateCassandraKeyspace operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_createUpdateCassandraTable operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_deleteCassandraKeyspace operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_deleteCassandraTable operation. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_migrateCassandraKeyspaceToAutoscale operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_migrateCassandraKeyspaceToManualThroughput operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_migrateCassandraTableToAutoscale operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_migrateCassandraTableToManualThroughput operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_updateCassandraKeyspaceThroughput operation. |
Cassandra |
Optional parameters. |
Cassandra |
Defines headers for CassandraResources_updateCassandraTableThroughput operation. |
Cassandra |
Optional parameters. |
Cassandra |
Cosmos DB Cassandra table schema |
Cassandra |
Parameters to create and update Cosmos DB Cassandra table. |
Cassandra |
Cosmos DB options resource object |
Cassandra |
Cosmos DB Cassandra table resource object |
Cassandra |
An Azure Cosmos DB Cassandra table. |
Cassandra |
The List operation response, that contains the Cassandra tables and their properties. |
Cassandra |
Cosmos DB Cassandra table resource object |
Certificate | |
Client |
. |
Client |
Parameters to create and update ClientEncryptionKey. |
Client |
Cosmos DB client encryption key resource object. |
Client |
Client Encryption Key. |
Client |
Cosmos DB client encryption key resource object. |
Client |
The List operation response, that contains the client encryption keys and their properties. |
Client |
Cosmos DB client encryption policy. |
Cluster |
Cosmos DB Cassandra table cluster key |
Cluster |
Representation of a managed Cassandra cluster. |
Cluster |
Properties of a managed Cassandra cluster. |
Collection |
Interface representing a Collection. |
Collection |
Optional parameters. |
Collection |
Optional parameters. |
Collection |
Optional parameters. |
Collection |
Interface representing a CollectionPartition. |
Collection |
Optional parameters. |
Collection |
Optional parameters. |
Collection |
Interface representing a CollectionPartitionRegion. |
Collection |
Optional parameters. |
Collection |
Interface representing a CollectionRegion. |
Collection |
Optional parameters. |
Column |
Cosmos DB Cassandra table column |
Command |
Response of /command api |
Command |
Specification of which command to run where |
Components1Jq1T4ISchemas |
|
ComponentsM9L909Schemas |
|
Composite |
|
Computed |
The definition of a computed property |
Conflict |
The conflict resolution policy for the container. |
Connection |
|
Consistency |
The consistency policy for the Cosmos DB database account. |
Container |
The configuration of the partition key to be used for partitioning data into multiple partitions |
Continuous |
Information about the status of continuous backups. |
Continuous |
Properties of the regional restorable account. |
Continuous |
The object representing continuous mode backup policy. |
Continuous |
Configuration values for periodic mode backup |
Cors |
The CORS policy for the Cosmos DB database account. |
Cosmos |
Optional parameters. |
Create |
CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" |
Data |
A managed Cassandra data center. |
Data |
Properties of a managed Cassandra data center. |
Data |
Resource for a regional service location. |
Data |
Describes the service response property. |
Data |
Properties for Create or Update request for DataTransferServiceResource |
Data |
Properties for DataTransferServiceResource. |
Database |
Interface representing a Database. |
Database |
Connection string for the Cosmos DB account |
Database |
Parameters to create and update Cosmos DB database accounts. |
Database |
An Azure Cosmos DB database account. |
Database |
The metadata related to each access key for the given Cosmos DB database account. |
Database |
The connection strings for the given database account. |
Database |
The access keys for the given database account. |
Database |
The read-only access keys for the given database account. |
Database |
Parameters to regenerate the keys within the database account. |
Database |
Interface representing a DatabaseAccountRegion. |
Database |
Optional parameters. |
Database |
Parameters for patching Azure Cosmos DB database account properties. |
Database |
Interface representing a DatabaseAccounts. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Defines headers for DatabaseAccounts_delete operation. |
Database |
Optional parameters. |
Database |
Defines headers for DatabaseAccounts_failoverPriorityChange operation. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
The List operation response, that contains the database accounts and their properties. |
Database |
Optional parameters. |
Database |
Defines headers for DatabaseAccounts_offlineRegion operation. |
Database |
Optional parameters. |
Database |
Defines headers for DatabaseAccounts_onlineRegion operation. |
Database |
Optional parameters. |
Database |
Defines headers for DatabaseAccounts_regenerateKey operation. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Optional parameters. |
Database |
Specific Databases to restore. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
Excluded |
|
Extended |
The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs. |
Failover |
The list of new failover policies for the failover priority change. |
Failover |
The failover policy for a given region of a database account. |
Graph |
Resource for a regional service location. |
Graph |
Describes the service response property for GraphAPICompute. |
Graph |
Properties for Create or Update request for GraphAPIComputeServiceResource |
Graph |
Properties for GraphAPIComputeServiceResource. |
Gremlin |
Parameters to create and update Cosmos DB Gremlin database. |
Gremlin |
Cosmos DB options resource object |
Gremlin |
Cosmos DB Gremlin database resource object |
Gremlin |
An Azure Cosmos DB Gremlin database. |
Gremlin |
The List operation response, that contains the Gremlin databases and their properties. |
Gremlin |
Cosmos DB Gremlin database resource object |
Gremlin |
Specific Gremlin Databases to restore. |
Gremlin |
Parameters to create and update Cosmos DB Gremlin graph. |
Gremlin |
Cosmos DB options resource object |
Gremlin |
Cosmos DB Gremlin graph resource object |
Gremlin |
An Azure Cosmos DB Gremlin graph. |
Gremlin |
The List operation response, that contains the graphs and their properties. |
Gremlin |
Cosmos DB Gremlin graph resource object |
Gremlin |
Interface representing a GremlinResources. |
Gremlin |
Defines headers for GremlinResources_createUpdateGremlinDatabase operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_createUpdateGremlinGraph operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_deleteGremlinDatabase operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_deleteGremlinGraph operation. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_migrateGremlinDatabaseToAutoscale operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_migrateGremlinDatabaseToManualThroughput operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_migrateGremlinGraphToAutoscale operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_migrateGremlinGraphToManualThroughput operation. |
Gremlin |
Optional parameters. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_updateGremlinDatabaseThroughput operation. |
Gremlin |
Optional parameters. |
Gremlin |
Defines headers for GremlinResources_updateGremlinGraphThroughput operation. |
Gremlin |
Optional parameters. |
Included |
The paths that are included in indexing |
Indexes |
The indexes for the path. |
Indexing |
Cosmos DB indexing policy |
Ip |
IpAddressOrRange object |
Key |
Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. |
List |
List of managed Cassandra clusters. |
List |
List of managed Cassandra data centers and their properties. |
Location |
A region in which the Azure Cosmos DB database account is deployed. |
Location |
Cosmos DB location get result |
Location |
The List operation response, that contains Cosmos DB locations and their properties. |
Location |
Cosmos DB location metadata |
Locations |
Interface representing a Locations. |
Locations |
Optional parameters. |
Locations |
Optional parameters. |
Managed |
The core properties of ARM resources. |
Managed |
Identity for the resource. |
Managed |
|
Managed |
Identity for the resource. |
Materialized |
Resource for a regional service location. |
Materialized |
Describes the service response property for MaterializedViewsBuilder. |
Materialized |
Properties for Create or Update request for MaterializedViewsBuilderServiceResource |
Materialized |
Properties for MaterializedViewsBuilderServiceResource. |
Metric |
Metric data |
Metric |
The availability of the metric. |
Metric |
The definition of a metric. |
Metric |
The response to a list metric definitions request. |
Metric |
The response to a list metrics request. |
Metric |
A metric name. |
Metric |
Represents metrics values. |
Mongo |
Parameters to create and update Cosmos DB MongoDB collection. |
Mongo |
Cosmos DB options resource object |
Mongo |
Cosmos DB MongoDB collection resource object |
Mongo |
An Azure Cosmos DB MongoDB collection. |
Mongo |
The List operation response, that contains the MongoDB collections and their properties. |
Mongo |
Cosmos DB MongoDB collection resource object |
Mongo |
Parameters to create and update Cosmos DB MongoDB database. |
Mongo |
Cosmos DB options resource object |
Mongo |
Cosmos DB MongoDB database resource object |
Mongo |
An Azure Cosmos DB MongoDB database. |
Mongo |
The List operation response, that contains the MongoDB databases and their properties. |
Mongo |
Cosmos DB MongoDB database resource object |
Mongo |
Interface representing a MongoDBResources. |
Mongo |
Defines headers for MongoDBResources_createUpdateMongoDBCollection operation. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_createUpdateMongoDBDatabase operation. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_deleteMongoDBCollection operation. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_deleteMongoDBDatabase operation. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_migrateMongoDBCollectionToAutoscale operation. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_migrateMongoDBCollectionToManualThroughput operation. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_migrateMongoDBDatabaseToAutoscale operation. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_migrateMongoDBDatabaseToManualThroughput operation. |
Mongo |
Optional parameters. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_updateMongoDBCollectionThroughput operation. |
Mongo |
Optional parameters. |
Mongo |
Defines headers for MongoDBResources_updateMongoDBDatabaseThroughput operation. |
Mongo |
Optional parameters. |
Mongo |
Cosmos DB MongoDB collection index key |
Mongo |
Cosmos DB MongoDB collection resource object |
Mongo |
Cosmos DB MongoDB collection index options |
Mongo |
Parameters to create and update an Azure Cosmos DB Mongo Role Definition. |
Mongo |
An Azure Cosmos DB Mongo Role Definition. |
Mongo |
The relevant Mongo Role Definitions. |
Mongo |
Parameters to create and update an Azure Cosmos DB Mongo User Definition. |
Mongo |
An Azure Cosmos DB User Definition |
Mongo |
The relevant User Definition. |
Notebook |
A notebook workspace resource |
Notebook |
The connection info for the given notebook workspace |
Notebook |
Parameters to create a notebook workspace resource |
Notebook |
A list of notebook workspace resources |
Notebook |
Interface representing a NotebookWorkspaces. |
Notebook |
Optional parameters. |
Notebook |
Optional parameters. |
Notebook |
Optional parameters. |
Notebook |
Optional parameters. |
Notebook |
Optional parameters. |
Notebook |
Optional parameters. |
Notebook |
Optional parameters. |
Operation |
REST API operation |
Operation |
The object that represents the operation. |
Operation |
Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results. |
Operations |
Interface representing a Operations. |
Operations |
Optional parameters. |
Operations |
Optional parameters. |
Options |
Cosmos DB options resource object |
Partition |
Interface representing a PartitionKeyRangeId. |
Partition |
Optional parameters. |
Partition |
Interface representing a PartitionKeyRangeIdRegion. |
Partition |
Optional parameters. |
Partition |
The metric values for a single partition. |
Partition |
The response to a list partition metrics request. |
Partition |
The partition level usage data for a usage request. |
Partition |
The response to a list partition level usage request. |
Percentile |
Interface representing a Percentile. |
Percentile |
Optional parameters. |
Percentile |
Percentile Metric data |
Percentile |
The response to a list percentile metrics request. |
Percentile |
Represents percentile metrics values. |
Percentile |
Interface representing a PercentileSourceTarget. |
Percentile |
Optional parameters. |
Percentile |
Interface representing a PercentileTarget. |
Percentile |
Optional parameters. |
Periodic |
The object representing periodic mode backup policy. |
Periodic |
Configuration values for periodic mode backup |
Permission |
The set of data plane operations permitted through this Role Definition. |
Private |
A private endpoint connection |
Private |
A list of private endpoint connections |
Private |
Interface representing a PrivateEndpointConnections. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Private endpoint which the connection belongs to. |
Private |
A private link resource |
Private |
A list of private link resources |
Private |
Interface representing a PrivateLinkResources. |
Private |
Optional parameters. |
Private |
Optional parameters. |
Private |
Connection State of the Private Endpoint Connection. |
Privilege |
The set of data plane operations permitted through this Role Definition. |
Privilege |
An Azure Cosmos DB Mongo DB Resource. |
Proxy |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
Region |
Cosmos DB region to online or offline. |
Regional |
Resource for a regional service location. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
Resource |
Parameters to indicate the information about the restore. |
Restorable |
A Azure Cosmos DB restorable database account. |
Restorable |
Interface representing a RestorableDatabaseAccounts. |
Restorable |
Optional parameters. |
Restorable |
Optional parameters. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the restorable database accounts and their properties. |
Restorable |
An Azure Cosmos DB Gremlin database event |
Restorable |
The resource of an Azure Cosmos DB Gremlin database event |
Restorable |
Interface representing a RestorableGremlinDatabases. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the Gremlin database events and their properties. |
Restorable |
An Azure Cosmos DB Gremlin graph event |
Restorable |
The resource of an Azure Cosmos DB Gremlin graph event |
Restorable |
Interface representing a RestorableGremlinGraphs. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the Gremlin graph events and their properties. |
Restorable |
Interface representing a RestorableGremlinResources. |
Restorable |
Specific Databases to restore. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the restorable Gremlin resources. |
Restorable |
Properties of the regional restorable account. |
Restorable |
An Azure Cosmos DB MongoDB collection event |
Restorable |
The resource of an Azure Cosmos DB MongoDB collection event |
Restorable |
Interface representing a RestorableMongodbCollections. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the MongoDB collection events and their properties. |
Restorable |
An Azure Cosmos DB MongoDB database event |
Restorable |
The resource of an Azure Cosmos DB MongoDB database event |
Restorable |
Interface representing a RestorableMongodbDatabases. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the MongoDB database events and their properties. |
Restorable |
Interface representing a RestorableMongodbResources. |
Restorable |
Specific Databases to restore. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the restorable MongoDB resources. |
Restorable |
An Azure Cosmos DB SQL container event |
Restorable |
The resource of an Azure Cosmos DB SQL container event |
Restorable |
Cosmos DB SQL container resource object |
Restorable |
Interface representing a RestorableSqlContainers. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the SQL container events and their properties. |
Restorable |
An Azure Cosmos DB SQL database event |
Restorable |
The resource of an Azure Cosmos DB SQL database event |
Restorable |
Cosmos DB SQL database resource object |
Restorable |
Interface representing a RestorableSqlDatabases. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the SQL database events and their properties. |
Restorable |
Interface representing a RestorableSqlResources. |
Restorable |
Specific Databases to restore. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the restorable SQL resources. |
Restorable |
An Azure Cosmos DB Table event |
Restorable |
The resource of an Azure Cosmos DB Table event |
Restorable |
Interface representing a RestorableTableResources. |
Restorable |
Specific Databases to restore. |
Restorable |
Optional parameters. |
Restorable |
List of restorable table names. |
Restorable |
Interface representing a RestorableTables. |
Restorable |
Optional parameters. |
Restorable |
The List operation response, that contains the Table events and their properties. |
Restore |
Parameters to indicate the information about the restore. |
Restore |
Parameters to indicate the information about the restore. |
Role |
The set of roles permitted through this Role Definition. |
Seed |
|
Service |
Interface representing a Service. |
Service |
Defines headers for Service_create operation. |
Service |
Optional parameters. |
Service |
Defines headers for Service_delete operation. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Properties for the database account. |
Service |
Parameters for Create or Update request for ServiceResource |
Service |
Properties in ServiceResourceCreateUpdateParameters. |
Service |
The List operation response, that contains the Service Resource and their properties. |
Service |
Services response resource. |
Spatial |
|
Sql |
Parameters to create and update Cosmos DB container. |
Sql |
Cosmos DB options resource object |
Sql |
Cosmos DB SQL container resource object |
Sql |
An Azure Cosmos DB container. |
Sql |
The List operation response, that contains the containers and their properties. |
Sql |
Cosmos DB SQL container resource object |
Sql |
Parameters to create and update Cosmos DB SQL database. |
Sql |
Cosmos DB options resource object |
Sql |
Cosmos DB SQL database resource object |
Sql |
An Azure Cosmos DB SQL database. |
Sql |
The List operation response, that contains the SQL databases and their properties. |
Sql |
Cosmos DB SQL database resource object |
Sql |
Resource for a regional service location. |
Sql |
Describes the service response property for SqlDedicatedGateway. |
Sql |
Properties for Create or Update request for SqlDedicatedGatewayServiceResource |
Sql |
Properties for SqlDedicatedGatewayServiceResource. |
Sql |
Interface representing a SqlResources. |
Sql |
Defines headers for SqlResources_createUpdateClientEncryptionKey operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_createUpdateSqlContainer operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_createUpdateSqlDatabase operation. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_createUpdateSqlStoredProcedure operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_createUpdateSqlTrigger operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_createUpdateSqlUserDefinedFunction operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_deleteSqlContainer operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_deleteSqlDatabase operation. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_deleteSqlStoredProcedure operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_deleteSqlTrigger operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_deleteSqlUserDefinedFunction operation. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_migrateSqlContainerToAutoscale operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_migrateSqlContainerToManualThroughput operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_migrateSqlDatabaseToAutoscale operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_migrateSqlDatabaseToManualThroughput operation. |
Sql |
Optional parameters. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_updateSqlContainerThroughput operation. |
Sql |
Optional parameters. |
Sql |
Defines headers for SqlResources_updateSqlDatabaseThroughput operation. |
Sql |
Optional parameters. |
Sql |
Parameters to create and update an Azure Cosmos DB SQL Role Assignment. |
Sql |
An Azure Cosmos DB Role Assignment |
Sql |
The relevant Role Assignments. |
Sql |
Parameters to create and update an Azure Cosmos DB SQL Role Definition. |
Sql |
An Azure Cosmos DB SQL Role Definition. |
Sql |
The relevant Role Definitions. |
Sql |
Parameters to create and update Cosmos DB storedProcedure. |
Sql |
Cosmos DB SQL storedProcedure resource object |
Sql |
An Azure Cosmos DB storedProcedure. |
Sql |
The List operation response, that contains the storedProcedures and their properties. |
Sql |
Cosmos DB SQL storedProcedure resource object |
Sql |
Parameters to create and update Cosmos DB trigger. |
Sql |
Cosmos DB SQL trigger resource object |
Sql |
An Azure Cosmos DB trigger. |
Sql |
The List operation response, that contains the triggers and their properties. |
Sql |
Cosmos DB SQL trigger resource object |
Sql |
Parameters to create and update Cosmos DB userDefinedFunction. |
Sql |
Cosmos DB SQL userDefinedFunction resource object |
Sql |
An Azure Cosmos DB userDefinedFunction. |
Sql |
The List operation response, that contains the userDefinedFunctions and their properties. |
Sql |
Cosmos DB SQL userDefinedFunction resource object |
System |
Metadata pertaining to creation and last modification of the resource. |
Table |
Parameters to create and update Cosmos DB Table. |
Table |
Cosmos DB options resource object |
Table |
Cosmos DB table resource object |
Table |
An Azure Cosmos DB Table. |
Table |
The List operation response, that contains the Table and their properties. |
Table |
Cosmos DB table resource object |
Table |
Interface representing a TableResources. |
Table |
Defines headers for TableResources_createUpdateTable operation. |
Table |
Optional parameters. |
Table |
Defines headers for TableResources_deleteTable operation. |
Table |
Optional parameters. |
Table |
Optional parameters. |
Table |
Optional parameters. |
Table |
Optional parameters. |
Table |
Defines headers for TableResources_migrateTableToAutoscale operation. |
Table |
Optional parameters. |
Table |
Defines headers for TableResources_migrateTableToManualThroughput operation. |
Table |
Optional parameters. |
Table |
Optional parameters. |
Table |
Defines headers for TableResources_updateTableThroughput operation. |
Table |
Optional parameters. |
Throughput |
Cosmos DB resource throughput policy |
Throughput |
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
Throughput |
An Azure Cosmos DB resource throughput. |
Throughput |
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
Throughput |
Parameters to update Cosmos DB resource throughput. |
Unique |
The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. |
Unique |
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. |
Usage |
The usage data for a usage request. |
Usages |
The response to a list usage request. |
Vector |
Represents a vector embedding. A vector embedding is used to define a vector field in the documents. |
Vector |
Cosmos DB Vector Embedding Policy |
Vector |
|
Virtual |
Virtual Network ACL Rule object |
Type Aliases
Analytical |
Defines values for AnalyticalStorageSchemaType. Known values supported by the serviceWellDefined |
Api |
Defines values for ApiType. Known values supported by the serviceMongoDB |
Authentication |
Defines values for AuthenticationMethod. Known values supported by the serviceNone |
Azure |
Defines values for AzureConnectionType. Known values supported by the serviceNone |
Backup |
Defines values for BackupPolicyMigrationStatus. Known values supported by the serviceInvalid |
Backup |
Defines values for BackupPolicyType. Known values supported by the servicePeriodic |
Backup |
|
Backup |
Defines values for BackupStorageRedundancy. Known values supported by the serviceGeo |
Cassandra |
Contains response data for the createUpdate operation. |
Cassandra |
Contains response data for the get operation. |
Cassandra |
Contains response data for the invokeCommand operation. |
Cassandra |
Contains response data for the listByResourceGroup operation. |
Cassandra |
Contains response data for the listBySubscription operation. |
Cassandra |
Contains response data for the status operation. |
Cassandra |
Contains response data for the update operation. |
Cassandra |
Contains response data for the createUpdate operation. |
Cassandra |
Contains response data for the get operation. |
Cassandra |
Contains response data for the list operation. |
Cassandra |
Contains response data for the update operation. |
Cassandra |
Contains response data for the createUpdateCassandraKeyspace operation. |
Cassandra |
Contains response data for the createUpdateCassandraTable operation. |
Cassandra |
Contains response data for the deleteCassandraKeyspace operation. |
Cassandra |
Contains response data for the deleteCassandraTable operation. |
Cassandra |
Contains response data for the getCassandraKeyspace operation. |
Cassandra |
Contains response data for the getCassandraKeyspaceThroughput operation. |
Cassandra |
Contains response data for the getCassandraTable operation. |
Cassandra |
Contains response data for the getCassandraTableThroughput operation. |
Cassandra |
Contains response data for the listCassandraKeyspaces operation. |
Cassandra |
Contains response data for the listCassandraTables operation. |
Cassandra |
Contains response data for the migrateCassandraKeyspaceToAutoscale operation. |
Cassandra |
Contains response data for the migrateCassandraKeyspaceToManualThroughput operation. |
Cassandra |
Contains response data for the migrateCassandraTableToAutoscale operation. |
Cassandra |
Contains response data for the migrateCassandraTableToManualThroughput operation. |
Cassandra |
Contains response data for the updateCassandraKeyspaceThroughput operation. |
Cassandra |
Contains response data for the updateCassandraTableThroughput operation. |
Collection |
Contains response data for the listMetricDefinitions operation. |
Collection |
Contains response data for the listMetrics operation. |
Collection |
Contains response data for the listUsages operation. |
Collection |
Contains response data for the listMetrics operation. |
Collection |
Contains response data for the listUsages operation. |
Collection |
Contains response data for the listMetrics operation. |
Collection |
Contains response data for the listMetrics operation. |
Composite |
Defines values for CompositePathSortOrder. Known values supported by the serviceascending |
Conflict |
Defines values for ConflictResolutionMode. Known values supported by the serviceLastWriterWins |
Connection |
Defines values for ConnectionState. Known values supported by the serviceUnknown |
Connector |
Defines values for ConnectorOffer. Known values supported by the serviceSmall |
Continuous |
Defines values for ContinuousTier. Known values supported by the serviceContinuous7Days |
Create |
Defines values for CreateMode. Known values supported by the serviceDefault |
Created |
Defines values for CreatedByType. Known values supported by the serviceUser |
Data |
Defines values for DataType. Known values supported by the serviceString |
Database |
Defines values for DatabaseAccountKind. Known values supported by the serviceGlobalDocumentDB |
Database |
Contains response data for the listMetrics operation. |
Database |
Contains response data for the checkNameExists operation. |
Database |
Contains response data for the createOrUpdate operation. |
Database |
Contains response data for the delete operation. |
Database |
Contains response data for the failoverPriorityChange operation. |
Database |
Contains response data for the getReadOnlyKeys operation. |
Database |
Contains response data for the get operation. |
Database |
Contains response data for the listByResourceGroup operation. |
Database |
Contains response data for the listConnectionStrings operation. |
Database |
Contains response data for the listKeys operation. |
Database |
Contains response data for the listMetricDefinitions operation. |
Database |
Contains response data for the listMetrics operation. |
Database |
Contains response data for the listReadOnlyKeys operation. |
Database |
Contains response data for the list operation. |
Database |
Contains response data for the listUsages operation. |
Database |
Contains response data for the update operation. |
Database |
Contains response data for the listMetricDefinitions operation. |
Database |
Contains response data for the listMetrics operation. |
Database |
Contains response data for the listUsages operation. |
Dedicated |
Defines values for DedicatedGatewayType. Known values supported by the serviceIntegratedCache |
Default |
Defines values for DefaultConsistencyLevel. |
Distance |
Defines values for DistanceFunction. Known values supported by the serviceeuclidean |
Gremlin |
Contains response data for the createUpdateGremlinDatabase operation. |
Gremlin |
Contains response data for the createUpdateGremlinGraph operation. |
Gremlin |
Contains response data for the deleteGremlinDatabase operation. |
Gremlin |
Contains response data for the deleteGremlinGraph operation. |
Gremlin |
Contains response data for the getGremlinDatabase operation. |
Gremlin |
Contains response data for the getGremlinDatabaseThroughput operation. |
Gremlin |
Contains response data for the getGremlinGraph operation. |
Gremlin |
Contains response data for the getGremlinGraphThroughput operation. |
Gremlin |
Contains response data for the listGremlinDatabases operation. |
Gremlin |
Contains response data for the listGremlinGraphs operation. |
Gremlin |
Contains response data for the migrateGremlinDatabaseToAutoscale operation. |
Gremlin |
Contains response data for the migrateGremlinDatabaseToManualThroughput operation. |
Gremlin |
Contains response data for the migrateGremlinGraphToAutoscale operation. |
Gremlin |
Contains response data for the migrateGremlinGraphToManualThroughput operation. |
Gremlin |
Contains response data for the retrieveContinuousBackupInformation operation. |
Gremlin |
Contains response data for the updateGremlinDatabaseThroughput operation. |
Gremlin |
Contains response data for the updateGremlinGraphThroughput operation. |
Index |
Defines values for IndexKind. Known values supported by the serviceHash |
Indexing |
Defines values for IndexingMode. Known values supported by the serviceconsistent |
Key |
Defines values for KeyKind. Known values supported by the serviceprimary |
Kind |
Defines values for Kind. Known values supported by the servicePrimary |
Locations |
Contains response data for the get operation. |
Locations |
Contains response data for the list operation. |
Managed |
Defines values for ManagedCassandraProvisioningState. Known values supported by the serviceCreating |
Managed |
Defines values for ManagedCassandraResourceIdentityType. Known values supported by the serviceSystemAssigned |
Minimal |
Defines values for MinimalTlsVersion. Known values supported by the serviceTls |
Mongo |
Contains response data for the createUpdateMongoDBCollection operation. |
Mongo |
Contains response data for the createUpdateMongoDBDatabase operation. |
Mongo |
Contains response data for the createUpdateMongoRoleDefinition operation. |
Mongo |
Contains response data for the createUpdateMongoUserDefinition operation. |
Mongo |
Contains response data for the deleteMongoDBCollection operation. |
Mongo |
Contains response data for the deleteMongoDBDatabase operation. |
Mongo |
Contains response data for the getMongoDBCollection operation. |
Mongo |
Contains response data for the getMongoDBCollectionThroughput operation. |
Mongo |
Contains response data for the getMongoDBDatabase operation. |
Mongo |
Contains response data for the getMongoDBDatabaseThroughput operation. |
Mongo |
Contains response data for the getMongoRoleDefinition operation. |
Mongo |
Contains response data for the getMongoUserDefinition operation. |
Mongo |
Contains response data for the listMongoDBCollections operation. |
Mongo |
Contains response data for the listMongoDBDatabases operation. |
Mongo |
Contains response data for the listMongoRoleDefinitions operation. |
Mongo |
Contains response data for the listMongoUserDefinitions operation. |
Mongo |
Contains response data for the migrateMongoDBCollectionToAutoscale operation. |
Mongo |
Contains response data for the migrateMongoDBCollectionToManualThroughput operation. |
Mongo |
Contains response data for the migrateMongoDBDatabaseToAutoscale operation. |
Mongo |
Contains response data for the migrateMongoDBDatabaseToManualThroughput operation. |
Mongo |
Contains response data for the retrieveContinuousBackupInformation operation. |
Mongo |
Contains response data for the updateMongoDBCollectionThroughput operation. |
Mongo |
Contains response data for the updateMongoDBDatabaseThroughput operation. |
Mongo |
Defines values for MongoRoleDefinitionType. |
Network |
Defines values for NetworkAclBypass. |
Node |
Defines values for NodeState. Known values supported by the serviceNormal |
Node |
Defines values for NodeStatus. Known values supported by the serviceUp |
Notebook |
Defines values for NotebookWorkspaceName. Known values supported by the servicedefault |
Notebook |
Contains response data for the createOrUpdate operation. |
Notebook |
Contains response data for the get operation. |
Notebook |
Contains response data for the listByDatabaseAccount operation. |
Notebook |
Contains response data for the listConnectionInfo operation. |
Operation |
Defines values for OperationType. Known values supported by the serviceCreate |
Operations |
Contains response data for the listNext operation. |
Operations |
Contains response data for the list operation. |
Partition |
Contains response data for the listMetrics operation. |
Partition |
Contains response data for the listMetrics operation. |
Partition |
Defines values for PartitionKind. Known values supported by the serviceHash |
Percentile |
Contains response data for the listMetrics operation. |
Percentile |
Contains response data for the listMetrics operation. |
Percentile |
Contains response data for the listMetrics operation. |
Primary |
Defines values for PrimaryAggregationType. Known values supported by the serviceNone |
Private |
Contains response data for the createOrUpdate operation. |
Private |
Contains response data for the get operation. |
Private |
Contains response data for the listByDatabaseAccount operation. |
Private |
Contains response data for the get operation. |
Private |
Contains response data for the listByDatabaseAccount operation. |
Public |
Defines values for PublicNetworkAccess. Known values supported by the serviceEnabled |
Resource |
Defines values for ResourceIdentityType. |
Restorable |
Contains response data for the getByLocation operation. |
Restorable |
Contains response data for the listByLocation operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restorable |
Contains response data for the list operation. |
Restore |
Defines values for RestoreMode. Known values supported by the servicePointInTime |
Role |
Defines values for RoleDefinitionType. |
Server |
Defines values for ServerVersion. Known values supported by the service3.2 |
Service |
Contains response data for the create operation. |
Service |
Contains response data for the get operation. |
Service |
Contains response data for the list operation. |
Service |
|
Service |
|
Service |
Defines values for ServiceSize. Known values supported by the serviceCosmos.D4s |
Service |
Defines values for ServiceStatus. Known values supported by the serviceCreating |
Service |
Defines values for ServiceType. Known values supported by the serviceSqlDedicatedGateway |
Spatial |
Defines values for SpatialType. Known values supported by the servicePoint |
Sql |
Contains response data for the createUpdateClientEncryptionKey operation. |
Sql |
Contains response data for the createUpdateSqlContainer operation. |
Sql |
Contains response data for the createUpdateSqlDatabase operation. |
Sql |
Contains response data for the createUpdateSqlRoleAssignment operation. |
Sql |
Contains response data for the createUpdateSqlRoleDefinition operation. |
Sql |
Contains response data for the createUpdateSqlStoredProcedure operation. |
Sql |
Contains response data for the createUpdateSqlTrigger operation. |
Sql |
Contains response data for the createUpdateSqlUserDefinedFunction operation. |
Sql |
Contains response data for the deleteSqlContainer operation. |
Sql |
Contains response data for the deleteSqlDatabase operation. |
Sql |
Contains response data for the deleteSqlStoredProcedure operation. |
Sql |
Contains response data for the deleteSqlTrigger operation. |
Sql |
Contains response data for the deleteSqlUserDefinedFunction operation. |
Sql |
Contains response data for the getClientEncryptionKey operation. |
Sql |
Contains response data for the getSqlContainer operation. |
Sql |
Contains response data for the getSqlContainerThroughput operation. |
Sql |
Contains response data for the getSqlDatabase operation. |
Sql |
Contains response data for the getSqlDatabaseThroughput operation. |
Sql |
Contains response data for the getSqlRoleAssignment operation. |
Sql |
Contains response data for the getSqlRoleDefinition operation. |
Sql |
Contains response data for the getSqlStoredProcedure operation. |
Sql |
Contains response data for the getSqlTrigger operation. |
Sql |
Contains response data for the getSqlUserDefinedFunction operation. |
Sql |
Contains response data for the listClientEncryptionKeys operation. |
Sql |
Contains response data for the listSqlContainers operation. |
Sql |
Contains response data for the listSqlDatabases operation. |
Sql |
Contains response data for the listSqlRoleAssignments operation. |
Sql |
Contains response data for the listSqlRoleDefinitions operation. |
Sql |
Contains response data for the listSqlStoredProcedures operation. |
Sql |
Contains response data for the listSqlTriggers operation. |
Sql |
Contains response data for the listSqlUserDefinedFunctions operation. |
Sql |
Contains response data for the migrateSqlContainerToAutoscale operation. |
Sql |
Contains response data for the migrateSqlContainerToManualThroughput operation. |
Sql |
Contains response data for the migrateSqlDatabaseToAutoscale operation. |
Sql |
Contains response data for the migrateSqlDatabaseToManualThroughput operation. |
Sql |
Contains response data for the retrieveContinuousBackupInformation operation. |
Sql |
Contains response data for the updateSqlContainerThroughput operation. |
Sql |
Contains response data for the updateSqlDatabaseThroughput operation. |
Status |
Defines values for Status. Known values supported by the serviceUninitialized |
Table |
Contains response data for the createUpdateTable operation. |
Table |
Contains response data for the deleteTable operation. |
Table |
Contains response data for the getTable operation. |
Table |
Contains response data for the getTableThroughput operation. |
Table |
Contains response data for the listTables operation. |
Table |
Contains response data for the migrateTableToAutoscale operation. |
Table |
Contains response data for the migrateTableToManualThroughput operation. |
Table |
Contains response data for the retrieveContinuousBackupInformation operation. |
Table |
Contains response data for the updateTableThroughput operation. |
Trigger |
Defines values for TriggerOperation. Known values supported by the serviceAll |
Trigger |
Defines values for TriggerType. Known values supported by the servicePre |
Type |
Defines values for Type. Known values supported by the serviceSql |
Unit |
Defines values for UnitType. Known values supported by the serviceCount |
Vector |
Defines values for VectorDataType. Known values supported by the servicefloat32 |
Vector |
Defines values for VectorIndexType. Known values supported by the serviceflat |
Enums
Known |
Known values of AnalyticalStorageSchemaType that the service accepts. |
Known |
Known values of ApiType that the service accepts. |
Known |
Known values of AuthenticationMethod that the service accepts. |
Known |
Known values of AzureConnectionType that the service accepts. |
Known |
Known values of BackupPolicyMigrationStatus that the service accepts. |
Known |
Known values of BackupPolicyType that the service accepts. |
Known |
Known values of BackupStorageRedundancy that the service accepts. |
Known |
Known values of CompositePathSortOrder that the service accepts. |
Known |
Known values of ConflictResolutionMode that the service accepts. |
Known |
Known values of ConnectionState that the service accepts. |
Known |
Known values of ConnectorOffer that the service accepts. |
Known |
Known values of ContinuousTier that the service accepts. |
Known |
Known values of CreateMode that the service accepts. |
Known |
Known values of CreatedByType that the service accepts. |
Known |
Known values of DataType that the service accepts. |
Known |
Known values of DatabaseAccountKind that the service accepts. |
Known |
Known values of DedicatedGatewayType that the service accepts. |
Known |
Known values of DistanceFunction that the service accepts. |
Known |
Known values of IndexKind that the service accepts. |
Known |
Known values of IndexingMode that the service accepts. |
Known |
Known values of KeyKind that the service accepts. |
Known |
Known values of Kind that the service accepts. |
Known |
Known values of ManagedCassandraProvisioningState that the service accepts. |
Known |
Known values of ManagedCassandraResourceIdentityType that the service accepts. |
Known |
Known values of MinimalTlsVersion that the service accepts. |
Known |
Known values of NodeState that the service accepts. |
Known |
Known values of NodeStatus that the service accepts. |
Known |
Known values of NotebookWorkspaceName that the service accepts. |
Known |
Known values of OperationType that the service accepts. |
Known |
Known values of PartitionKind that the service accepts. |
Known |
Known values of PrimaryAggregationType that the service accepts. |
Known |
Known values of PublicNetworkAccess that the service accepts. |
Known |
Known values of RestoreMode that the service accepts. |
Known |
Known values of ServerVersion that the service accepts. |
Known |
Known values of ServiceSize that the service accepts. |
Known |
Known values of ServiceStatus that the service accepts. |
Known |
Known values of ServiceType that the service accepts. |
Known |
Known values of SpatialType that the service accepts. |
Known |
Known values of Status that the service accepts. |
Known |
Known values of TriggerOperation that the service accepts. |
Known |
Known values of TriggerType that the service accepts. |
Known |
Known values of Type that the service accepts. |
Known |
Known values of UnitType that the service accepts. |
Known |
Known values of VectorDataType that the service accepts. |
Known |
Known values of VectorIndexType that the service accepts. |
Functions
get |
Given the last |
getContinuationToken(unknown)
Given the last .value
produced by the byPage
iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value
on the IteratorResult from a byPage
iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.