@azure/arm-cosmosdb package
Classes
| CosmosDBManagementClient |
Interfaces
| ARMProxyResource |
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags |
| ARMResourceProperties |
The core properties of ARM resources. |
| AccountKeyMetadata |
The metadata related to an access key for a given database account. |
| AnalyticalStorageConfiguration |
Analytical storage specific properties. |
| ApiProperties | |
| AuthenticationMethodLdapProperties |
Ldap authentication method properties. This feature is in preview. |
| AutoUpgradePolicyResource |
Cosmos DB resource auto-upgrade policy |
| AutoscaleSettings | |
| AutoscaleSettingsResource |
Cosmos DB provisioned throughput settings object |
| BackupInformation |
Backup information of a resource. |
| BackupPolicy |
The object representing the policy for taking backups on an account. |
| BackupPolicyMigrationState |
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. |
| CassandraClusterPublicStatus |
Properties of a managed Cassandra cluster public status. |
| CassandraClusterPublicStatusDataCentersItem | |
| CassandraClusters |
Interface representing a CassandraClusters. |
| CassandraClustersCreateUpdateOptionalParams |
Optional parameters. |
| CassandraClustersDeallocateOptionalParams |
Optional parameters. |
| CassandraClustersDeleteOptionalParams |
Optional parameters. |
| CassandraClustersGetOptionalParams |
Optional parameters. |
| CassandraClustersInvokeCommandOptionalParams |
Optional parameters. |
| CassandraClustersListByResourceGroupOptionalParams |
Optional parameters. |
| CassandraClustersListBySubscriptionOptionalParams |
Optional parameters. |
| CassandraClustersStartOptionalParams |
Optional parameters. |
| CassandraClustersStatusOptionalParams |
Optional parameters. |
| CassandraClustersUpdateOptionalParams |
Optional parameters. |
| CassandraDataCenters |
Interface representing a CassandraDataCenters. |
| CassandraDataCentersCreateUpdateOptionalParams |
Optional parameters. |
| CassandraDataCentersDeleteOptionalParams |
Optional parameters. |
| CassandraDataCentersGetOptionalParams |
Optional parameters. |
| CassandraDataCentersListOptionalParams |
Optional parameters. |
| CassandraDataCentersUpdateOptionalParams |
Optional parameters. |
| CassandraError | |
| CassandraKeyspaceCreateUpdateParameters |
Parameters to create and update Cosmos DB Cassandra keyspace. |
| CassandraKeyspaceGetPropertiesOptions |
Cosmos DB options resource object |
| CassandraKeyspaceGetPropertiesResource |
Cosmos DB Cassandra keyspace resource object |
| CassandraKeyspaceGetResults |
An Azure Cosmos DB Cassandra keyspace. |
| CassandraKeyspaceListResult |
The List operation response, that contains the Cassandra keyspaces and their properties. |
| CassandraKeyspaceResource |
Cosmos DB Cassandra keyspace resource object |
| CassandraPartitionKey |
Cosmos DB Cassandra table partition key |
| CassandraResources |
Interface representing a CassandraResources. |
| CassandraResourcesCreateUpdateCassandraKeyspaceHeaders |
Defines headers for CassandraResources_createUpdateCassandraKeyspace operation. |
| CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams |
Optional parameters. |
| CassandraResourcesCreateUpdateCassandraTableHeaders |
Defines headers for CassandraResources_createUpdateCassandraTable operation. |
| CassandraResourcesCreateUpdateCassandraTableOptionalParams |
Optional parameters. |
| CassandraResourcesDeleteCassandraKeyspaceHeaders |
Defines headers for CassandraResources_deleteCassandraKeyspace operation. |
| CassandraResourcesDeleteCassandraKeyspaceOptionalParams |
Optional parameters. |
| CassandraResourcesDeleteCassandraTableHeaders |
Defines headers for CassandraResources_deleteCassandraTable operation. |
| CassandraResourcesDeleteCassandraTableOptionalParams |
Optional parameters. |
| CassandraResourcesGetCassandraKeyspaceOptionalParams |
Optional parameters. |
| CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams |
Optional parameters. |
| CassandraResourcesGetCassandraTableOptionalParams |
Optional parameters. |
| CassandraResourcesGetCassandraTableThroughputOptionalParams |
Optional parameters. |
| CassandraResourcesListCassandraKeyspacesOptionalParams |
Optional parameters. |
| CassandraResourcesListCassandraTablesOptionalParams |
Optional parameters. |
| CassandraResourcesMigrateCassandraKeyspaceToAutoscaleHeaders |
Defines headers for CassandraResources_migrateCassandraKeyspaceToAutoscale operation. |
| CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams |
Optional parameters. |
| CassandraResourcesMigrateCassandraKeyspaceToManualThroughputHeaders |
Defines headers for CassandraResources_migrateCassandraKeyspaceToManualThroughput operation. |
| CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams |
Optional parameters. |
| CassandraResourcesMigrateCassandraTableToAutoscaleHeaders |
Defines headers for CassandraResources_migrateCassandraTableToAutoscale operation. |
| CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams |
Optional parameters. |
| CassandraResourcesMigrateCassandraTableToManualThroughputHeaders |
Defines headers for CassandraResources_migrateCassandraTableToManualThroughput operation. |
| CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams |
Optional parameters. |
| CassandraResourcesUpdateCassandraKeyspaceThroughputHeaders |
Defines headers for CassandraResources_updateCassandraKeyspaceThroughput operation. |
| CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams |
Optional parameters. |
| CassandraResourcesUpdateCassandraTableThroughputHeaders |
Defines headers for CassandraResources_updateCassandraTableThroughput operation. |
| CassandraResourcesUpdateCassandraTableThroughputOptionalParams |
Optional parameters. |
| CassandraSchema |
Cosmos DB Cassandra table schema |
| CassandraTableCreateUpdateParameters |
Parameters to create and update Cosmos DB Cassandra table. |
| CassandraTableGetPropertiesOptions |
Cosmos DB options resource object |
| CassandraTableGetPropertiesResource |
Cosmos DB Cassandra table resource object |
| CassandraTableGetResults |
An Azure Cosmos DB Cassandra table. |
| CassandraTableListResult |
The List operation response, that contains the Cassandra tables and their properties. |
| CassandraTableResource |
Cosmos DB Cassandra table resource object |
| Certificate | |
| ClientEncryptionIncludedPath |
. |
| ClientEncryptionKeyCreateUpdateParameters |
Parameters to create and update ClientEncryptionKey. |
| ClientEncryptionKeyGetPropertiesResource |
Cosmos DB client encryption key resource object. |
| ClientEncryptionKeyGetResults |
Client Encryption Key. |
| ClientEncryptionKeyResource |
Cosmos DB client encryption key resource object. |
| ClientEncryptionKeysListResult |
The List operation response, that contains the client encryption keys and their properties. |
| ClientEncryptionPolicy |
Cosmos DB client encryption policy. |
| ClusterKey |
Cosmos DB Cassandra table cluster key |
| ClusterResource |
Representation of a managed Cassandra cluster. |
| ClusterResourceProperties |
Properties of a managed Cassandra cluster. |
| Collection |
Interface representing a Collection. |
| CollectionListMetricDefinitionsOptionalParams |
Optional parameters. |
| CollectionListMetricsOptionalParams |
Optional parameters. |
| CollectionListUsagesOptionalParams |
Optional parameters. |
| CollectionPartition |
Interface representing a CollectionPartition. |
| CollectionPartitionListMetricsOptionalParams |
Optional parameters. |
| CollectionPartitionListUsagesOptionalParams |
Optional parameters. |
| CollectionPartitionRegion |
Interface representing a CollectionPartitionRegion. |
| CollectionPartitionRegionListMetricsOptionalParams |
Optional parameters. |
| CollectionRegion |
Interface representing a CollectionRegion. |
| CollectionRegionListMetricsOptionalParams |
Optional parameters. |
| Column |
Cosmos DB Cassandra table column |
| CommandOutput |
Response of /command api |
| CommandPostBody |
Specification of which command to run where |
| Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties | |
| ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems | |
| CompositePath | |
| ComputedProperty |
The definition of a computed property |
| ConflictResolutionPolicy |
The conflict resolution policy for the container. |
| ConnectionError | |
| ConsistencyPolicy |
The consistency policy for the Cosmos DB database account. |
| ContainerPartitionKey |
The configuration of the partition key to be used for partitioning data into multiple partitions |
| ContinuousBackupInformation |
Information about the status of continuous backups. |
| ContinuousBackupRestoreLocation |
Properties of the regional restorable account. |
| ContinuousModeBackupPolicy |
The object representing continuous mode backup policy. |
| ContinuousModeProperties |
Configuration values for periodic mode backup |
| CorsPolicy |
The CORS policy for the Cosmos DB database account. |
| CosmosDBManagementClientOptionalParams |
Optional parameters. |
| CreateUpdateOptions |
CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" |
| DataCenterResource |
A managed Cassandra data center. |
| DataCenterResourceProperties |
Properties of a managed Cassandra data center. |
| DataTransferRegionalServiceResource |
Resource for a regional service location. |
| DataTransferServiceResource |
Describes the service response property. |
| DataTransferServiceResourceCreateUpdateProperties |
Properties for Create or Update request for DataTransferServiceResource |
| DataTransferServiceResourceProperties |
Properties for DataTransferServiceResource. |
| Database |
Interface representing a Database. |
| DatabaseAccountConnectionString |
Connection string for the Cosmos DB account |
| DatabaseAccountCreateUpdateParameters |
Parameters to create and update Cosmos DB database accounts. |
| DatabaseAccountGetResults |
An Azure Cosmos DB database account. |
| DatabaseAccountKeysMetadata |
The metadata related to each access key for the given Cosmos DB database account. |
| DatabaseAccountListConnectionStringsResult |
The connection strings for the given database account. |
| DatabaseAccountListKeysResult |
The access keys for the given database account. |
| DatabaseAccountListReadOnlyKeysResult |
The read-only access keys for the given database account. |
| DatabaseAccountRegenerateKeyParameters |
Parameters to regenerate the keys within the database account. |
| DatabaseAccountRegion |
Interface representing a DatabaseAccountRegion. |
| DatabaseAccountRegionListMetricsOptionalParams |
Optional parameters. |
| DatabaseAccountUpdateParameters |
Parameters for patching Azure Cosmos DB database account properties. |
| DatabaseAccounts |
Interface representing a DatabaseAccounts. |
| DatabaseAccountsCheckNameExistsOptionalParams |
Optional parameters. |
| DatabaseAccountsCreateOrUpdateOptionalParams |
Optional parameters. |
| DatabaseAccountsDeleteHeaders |
Defines headers for DatabaseAccounts_delete operation. |
| DatabaseAccountsDeleteOptionalParams |
Optional parameters. |
| DatabaseAccountsFailoverPriorityChangeHeaders |
Defines headers for DatabaseAccounts_failoverPriorityChange operation. |
| DatabaseAccountsFailoverPriorityChangeOptionalParams |
Optional parameters. |
| DatabaseAccountsGetOptionalParams |
Optional parameters. |
| DatabaseAccountsGetReadOnlyKeysOptionalParams |
Optional parameters. |
| DatabaseAccountsListByResourceGroupOptionalParams |
Optional parameters. |
| DatabaseAccountsListConnectionStringsOptionalParams |
Optional parameters. |
| DatabaseAccountsListKeysOptionalParams |
Optional parameters. |
| DatabaseAccountsListMetricDefinitionsOptionalParams |
Optional parameters. |
| DatabaseAccountsListMetricsOptionalParams |
Optional parameters. |
| DatabaseAccountsListOptionalParams |
Optional parameters. |
| DatabaseAccountsListReadOnlyKeysOptionalParams |
Optional parameters. |
| DatabaseAccountsListResult |
The List operation response, that contains the database accounts and their properties. |
| DatabaseAccountsListUsagesOptionalParams |
Optional parameters. |
| DatabaseAccountsOfflineRegionHeaders |
Defines headers for DatabaseAccounts_offlineRegion operation. |
| DatabaseAccountsOfflineRegionOptionalParams |
Optional parameters. |
| DatabaseAccountsOnlineRegionHeaders |
Defines headers for DatabaseAccounts_onlineRegion operation. |
| DatabaseAccountsOnlineRegionOptionalParams |
Optional parameters. |
| DatabaseAccountsRegenerateKeyHeaders |
Defines headers for DatabaseAccounts_regenerateKey operation. |
| DatabaseAccountsRegenerateKeyOptionalParams |
Optional parameters. |
| DatabaseAccountsUpdateOptionalParams |
Optional parameters. |
| DatabaseListMetricDefinitionsOptionalParams |
Optional parameters. |
| DatabaseListMetricsOptionalParams |
Optional parameters. |
| DatabaseListUsagesOptionalParams |
Optional parameters. |
| DatabaseRestoreResource |
Specific Databases to restore. |
| 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. (This also follows the OData error response format.). |
| ExcludedPath | |
| ExtendedResourceProperties |
The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs. |
| FailoverPolicies |
The list of new failover policies for the failover priority change. |
| FailoverPolicy |
The failover policy for a given region of a database account. |
| Fleet |
Interface representing a Fleet. |
| FleetCreateOptionalParams |
Optional parameters. |
| FleetDeleteHeaders |
Defines headers for Fleet_delete operation. |
| FleetDeleteOptionalParams |
Optional parameters. |
| FleetGetOptionalParams |
Optional parameters. |
| FleetListByResourceGroupNextOptionalParams |
Optional parameters. |
| FleetListByResourceGroupOptionalParams |
Optional parameters. |
| FleetListNextOptionalParams |
Optional parameters. |
| FleetListOptionalParams |
Optional parameters. |
| FleetListResult |
The response of the List operation that contains the fleets and their properties. |
| FleetResource |
An Azure Cosmos DB FleetResource. |
| FleetResourceUpdate |
Represents a fleet resource for updates. |
| FleetUpdateOptionalParams |
Optional parameters. |
| Fleetspace |
Interface representing a Fleetspace. |
| FleetspaceAccount |
Interface representing a FleetspaceAccount. |
| FleetspaceAccountCreateOptionalParams |
Optional parameters. |
| FleetspaceAccountDeleteHeaders |
Defines headers for FleetspaceAccount_delete operation. |
| FleetspaceAccountDeleteOptionalParams |
Optional parameters. |
| FleetspaceAccountGetOptionalParams |
Optional parameters. |
| FleetspaceAccountListNextOptionalParams |
Optional parameters. |
| FleetspaceAccountListOptionalParams |
Optional parameters. |
| FleetspaceAccountListResult |
The List operation response, that contains the global database accounts and their properties. |
| FleetspaceAccountPropertiesGlobalDatabaseAccountProperties |
Configuration for fleetspace Account in the fleetspace. |
| FleetspaceAccountResource |
An Azure Cosmos DB Fleetspace Account |
| FleetspaceCreateOptionalParams |
Optional parameters. |
| FleetspaceDeleteHeaders |
Defines headers for Fleetspace_delete operation. |
| FleetspaceDeleteOptionalParams |
Optional parameters. |
| FleetspaceGetOptionalParams |
Optional parameters. |
| FleetspaceListNextOptionalParams |
Optional parameters. |
| FleetspaceListOptionalParams |
Optional parameters. |
| FleetspaceListResult |
The response of the List operation that contains the fleetspaces and their properties. |
| FleetspacePropertiesThroughputPoolConfiguration |
Configuration for throughput pool in the fleetspace. |
| FleetspaceResource |
An Azure Cosmos DB Fleetspace. |
| FleetspaceUpdate |
Represents a fleetspace resource for updates. |
| FleetspaceUpdateHeaders |
Defines headers for Fleetspace_update operation. |
| FleetspaceUpdateOptionalParams |
Optional parameters. |
| FullTextIndexPath |
Represents the full text index path. |
| FullTextPath |
Represents the full text path specification. |
| FullTextPolicy |
Cosmos DB FullText Policy |
| GraphAPIComputeRegionalServiceResource |
Resource for a regional service location. |
| GraphAPIComputeServiceResource |
Describes the service response property for GraphAPICompute. |
| GraphAPIComputeServiceResourceCreateUpdateProperties |
Properties for Create or Update request for GraphAPIComputeServiceResource |
| GraphAPIComputeServiceResourceProperties |
Properties for GraphAPIComputeServiceResource. |
| GremlinDatabaseCreateUpdateParameters |
Parameters to create and update Cosmos DB Gremlin database. |
| GremlinDatabaseGetPropertiesOptions |
Cosmos DB options resource object |
| GremlinDatabaseGetPropertiesResource |
Cosmos DB Gremlin database resource object |
| GremlinDatabaseGetResults |
An Azure Cosmos DB Gremlin database. |
| GremlinDatabaseListResult |
The List operation response, that contains the Gremlin databases and their properties. |
| GremlinDatabaseResource |
Cosmos DB Gremlin database resource object |
| GremlinDatabaseRestoreResource |
Specific Gremlin Databases to restore. |
| GremlinGraphCreateUpdateParameters |
Parameters to create and update Cosmos DB Gremlin graph. |
| GremlinGraphGetPropertiesOptions |
Cosmos DB options resource object |
| GremlinGraphGetPropertiesResource |
Cosmos DB Gremlin graph resource object |
| GremlinGraphGetResults |
An Azure Cosmos DB Gremlin graph. |
| GremlinGraphListResult |
The List operation response, that contains the graphs and their properties. |
| GremlinGraphResource |
Cosmos DB Gremlin graph resource object |
| GremlinResources |
Interface representing a GremlinResources. |
| GremlinResourcesCreateUpdateGremlinDatabaseHeaders |
Defines headers for GremlinResources_createUpdateGremlinDatabase operation. |
| GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams |
Optional parameters. |
| GremlinResourcesCreateUpdateGremlinGraphHeaders |
Defines headers for GremlinResources_createUpdateGremlinGraph operation. |
| GremlinResourcesCreateUpdateGremlinGraphOptionalParams |
Optional parameters. |
| GremlinResourcesDeleteGremlinDatabaseHeaders |
Defines headers for GremlinResources_deleteGremlinDatabase operation. |
| GremlinResourcesDeleteGremlinDatabaseOptionalParams |
Optional parameters. |
| GremlinResourcesDeleteGremlinGraphHeaders |
Defines headers for GremlinResources_deleteGremlinGraph operation. |
| GremlinResourcesDeleteGremlinGraphOptionalParams |
Optional parameters. |
| GremlinResourcesGetGremlinDatabaseOptionalParams |
Optional parameters. |
| GremlinResourcesGetGremlinDatabaseThroughputOptionalParams |
Optional parameters. |
| GremlinResourcesGetGremlinGraphOptionalParams |
Optional parameters. |
| GremlinResourcesGetGremlinGraphThroughputOptionalParams |
Optional parameters. |
| GremlinResourcesListGremlinDatabasesOptionalParams |
Optional parameters. |
| GremlinResourcesListGremlinGraphsOptionalParams |
Optional parameters. |
| GremlinResourcesMigrateGremlinDatabaseToAutoscaleHeaders |
Defines headers for GremlinResources_migrateGremlinDatabaseToAutoscale operation. |
| GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams |
Optional parameters. |
| GremlinResourcesMigrateGremlinDatabaseToManualThroughputHeaders |
Defines headers for GremlinResources_migrateGremlinDatabaseToManualThroughput operation. |
| GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams |
Optional parameters. |
| GremlinResourcesMigrateGremlinGraphToAutoscaleHeaders |
Defines headers for GremlinResources_migrateGremlinGraphToAutoscale operation. |
| GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams |
Optional parameters. |
| GremlinResourcesMigrateGremlinGraphToManualThroughputHeaders |
Defines headers for GremlinResources_migrateGremlinGraphToManualThroughput operation. |
| GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams |
Optional parameters. |
| GremlinResourcesRetrieveContinuousBackupInformationOptionalParams |
Optional parameters. |
| GremlinResourcesUpdateGremlinDatabaseThroughputHeaders |
Defines headers for GremlinResources_updateGremlinDatabaseThroughput operation. |
| GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams |
Optional parameters. |
| GremlinResourcesUpdateGremlinGraphThroughputHeaders |
Defines headers for GremlinResources_updateGremlinGraphThroughput operation. |
| GremlinResourcesUpdateGremlinGraphThroughputOptionalParams |
Optional parameters. |
| IncludedPath |
The paths that are included in indexing |
| Indexes |
The indexes for the path. |
| IndexingPolicy |
Cosmos DB indexing policy |
| IpAddressOrRange |
IpAddressOrRange object |
| KeyWrapMetadata |
Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. |
| ListClusters |
List of managed Cassandra clusters. |
| ListDataCenters |
List of managed Cassandra data centers and their properties. |
| Location |
A region in which the Azure Cosmos DB database account is deployed. |
| LocationGetResult |
Cosmos DB location get result |
| LocationListResult |
The List operation response, that contains Cosmos DB locations and their properties. |
| LocationProperties |
Cosmos DB location metadata |
| Locations |
Interface representing a Locations. |
| LocationsGetOptionalParams |
Optional parameters. |
| LocationsListOptionalParams |
Optional parameters. |
| ManagedCassandraARMResourceProperties |
The core properties of ARM resources. |
| ManagedCassandraManagedServiceIdentity |
Identity for the resource. |
| ManagedCassandraReaperStatus | |
| ManagedServiceIdentity |
Identity for the resource. |
| MaterializedViewsBuilderRegionalServiceResource |
Resource for a regional service location. |
| MaterializedViewsBuilderServiceResource |
Describes the service response property for MaterializedViewsBuilder. |
| MaterializedViewsBuilderServiceResourceCreateUpdateProperties |
Properties for Create or Update request for MaterializedViewsBuilderServiceResource |
| MaterializedViewsBuilderServiceResourceProperties |
Properties for MaterializedViewsBuilderServiceResource. |
| Metric |
Metric data |
| MetricAvailability |
The availability of the metric. |
| MetricDefinition |
The definition of a metric. |
| MetricDefinitionsListResult |
The response to a list metric definitions request. |
| MetricListResult |
The response to a list metrics request. |
| MetricName |
A metric name. |
| MetricValue |
Represents metrics values. |
| MongoDBCollectionCreateUpdateParameters |
Parameters to create and update Cosmos DB MongoDB collection. |
| MongoDBCollectionGetPropertiesOptions |
Cosmos DB options resource object |
| MongoDBCollectionGetPropertiesResource |
Cosmos DB MongoDB collection resource object |
| MongoDBCollectionGetResults |
An Azure Cosmos DB MongoDB collection. |
| MongoDBCollectionListResult |
The List operation response, that contains the MongoDB collections and their properties. |
| MongoDBCollectionResource |
Cosmos DB MongoDB collection resource object |
| MongoDBDatabaseCreateUpdateParameters |
Parameters to create and update Cosmos DB MongoDB database. |
| MongoDBDatabaseGetPropertiesOptions |
Cosmos DB options resource object |
| MongoDBDatabaseGetPropertiesResource |
Cosmos DB MongoDB database resource object |
| MongoDBDatabaseGetResults |
An Azure Cosmos DB MongoDB database. |
| MongoDBDatabaseListResult |
The List operation response, that contains the MongoDB databases and their properties. |
| MongoDBDatabaseResource |
Cosmos DB MongoDB database resource object |
| MongoDBResources |
Interface representing a MongoDBResources. |
| MongoDBResourcesCreateUpdateMongoDBCollectionHeaders |
Defines headers for MongoDBResources_createUpdateMongoDBCollection operation. |
| MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams |
Optional parameters. |
| MongoDBResourcesCreateUpdateMongoDBDatabaseHeaders |
Defines headers for MongoDBResources_createUpdateMongoDBDatabase operation. |
| MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams |
Optional parameters. |
| MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams |
Optional parameters. |
| MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams |
Optional parameters. |
| MongoDBResourcesDeleteMongoDBCollectionHeaders |
Defines headers for MongoDBResources_deleteMongoDBCollection operation. |
| MongoDBResourcesDeleteMongoDBCollectionOptionalParams |
Optional parameters. |
| MongoDBResourcesDeleteMongoDBDatabaseHeaders |
Defines headers for MongoDBResources_deleteMongoDBDatabase operation. |
| MongoDBResourcesDeleteMongoDBDatabaseOptionalParams |
Optional parameters. |
| MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams |
Optional parameters. |
| MongoDBResourcesDeleteMongoUserDefinitionOptionalParams |
Optional parameters. |
| MongoDBResourcesGetMongoDBCollectionOptionalParams |
Optional parameters. |
| MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams |
Optional parameters. |
| MongoDBResourcesGetMongoDBDatabaseOptionalParams |
Optional parameters. |
| MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams |
Optional parameters. |
| MongoDBResourcesGetMongoRoleDefinitionOptionalParams |
Optional parameters. |
| MongoDBResourcesGetMongoUserDefinitionOptionalParams |
Optional parameters. |
| MongoDBResourcesListMongoDBCollectionsOptionalParams |
Optional parameters. |
| MongoDBResourcesListMongoDBDatabasesOptionalParams |
Optional parameters. |
| MongoDBResourcesListMongoRoleDefinitionsOptionalParams |
Optional parameters. |
| MongoDBResourcesListMongoUserDefinitionsOptionalParams |
Optional parameters. |
| MongoDBResourcesMigrateMongoDBCollectionToAutoscaleHeaders |
Defines headers for MongoDBResources_migrateMongoDBCollectionToAutoscale operation. |
| MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams |
Optional parameters. |
| MongoDBResourcesMigrateMongoDBCollectionToManualThroughputHeaders |
Defines headers for MongoDBResources_migrateMongoDBCollectionToManualThroughput operation. |
| MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams |
Optional parameters. |
| MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleHeaders |
Defines headers for MongoDBResources_migrateMongoDBDatabaseToAutoscale operation. |
| MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams |
Optional parameters. |
| MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputHeaders |
Defines headers for MongoDBResources_migrateMongoDBDatabaseToManualThroughput operation. |
| MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams |
Optional parameters. |
| MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams |
Optional parameters. |
| MongoDBResourcesUpdateMongoDBCollectionThroughputHeaders |
Defines headers for MongoDBResources_updateMongoDBCollectionThroughput operation. |
| MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams |
Optional parameters. |
| MongoDBResourcesUpdateMongoDBDatabaseThroughputHeaders |
Defines headers for MongoDBResources_updateMongoDBDatabaseThroughput operation. |
| MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams |
Optional parameters. |
| MongoIndex |
Cosmos DB MongoDB collection index key |
| MongoIndexKeys |
Cosmos DB MongoDB collection resource object |
| MongoIndexOptions |
Cosmos DB MongoDB collection index options |
| MongoRoleDefinitionCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB Mongo Role Definition. |
| MongoRoleDefinitionGetResults |
An Azure Cosmos DB Mongo Role Definition. |
| MongoRoleDefinitionListResult |
The relevant Mongo Role Definitions. |
| MongoUserDefinitionCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB Mongo User Definition. |
| MongoUserDefinitionGetResults |
An Azure Cosmos DB User Definition |
| MongoUserDefinitionListResult |
The relevant User Definition. |
| NotebookWorkspace |
A notebook workspace resource |
| NotebookWorkspaceConnectionInfoResult |
The connection info for the given notebook workspace |
| NotebookWorkspaceCreateUpdateParameters |
Parameters to create a notebook workspace resource |
| NotebookWorkspaceListResult |
A list of notebook workspace resources |
| NotebookWorkspaces |
Interface representing a NotebookWorkspaces. |
| NotebookWorkspacesCreateOrUpdateOptionalParams |
Optional parameters. |
| NotebookWorkspacesDeleteOptionalParams |
Optional parameters. |
| NotebookWorkspacesGetOptionalParams |
Optional parameters. |
| NotebookWorkspacesListByDatabaseAccountOptionalParams |
Optional parameters. |
| NotebookWorkspacesListConnectionInfoOptionalParams |
Optional parameters. |
| NotebookWorkspacesRegenerateAuthTokenOptionalParams |
Optional parameters. |
| NotebookWorkspacesStartOptionalParams |
Optional parameters. |
| Operation |
REST API operation |
| OperationDisplay |
The object that represents the operation. |
| OperationListResult |
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. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| OptionsResource |
Cosmos DB options resource object |
| PartitionKeyRangeId |
Interface representing a PartitionKeyRangeId. |
| PartitionKeyRangeIdListMetricsOptionalParams |
Optional parameters. |
| PartitionKeyRangeIdRegion |
Interface representing a PartitionKeyRangeIdRegion. |
| PartitionKeyRangeIdRegionListMetricsOptionalParams |
Optional parameters. |
| PartitionMetric |
The metric values for a single partition. |
| PartitionMetricListResult |
The response to a list partition metrics request. |
| PartitionUsage |
The partition level usage data for a usage request. |
| PartitionUsagesResult |
The response to a list partition level usage request. |
| Percentile |
Interface representing a Percentile. |
| PercentileListMetricsOptionalParams |
Optional parameters. |
| PercentileMetric |
Percentile Metric data |
| PercentileMetricListResult |
The response to a list percentile metrics request. |
| PercentileMetricValue |
Represents percentile metrics values. |
| PercentileSourceTarget |
Interface representing a PercentileSourceTarget. |
| PercentileSourceTargetListMetricsOptionalParams |
Optional parameters. |
| PercentileTarget |
Interface representing a PercentileTarget. |
| PercentileTargetListMetricsOptionalParams |
Optional parameters. |
| PeriodicModeBackupPolicy |
The object representing periodic mode backup policy. |
| PeriodicModeProperties |
Configuration values for periodic mode backup |
| Permission |
The set of data plane operations permitted through this Role Definition. |
| PrivateEndpointConnection |
A private endpoint connection |
| PrivateEndpointConnectionListResult |
A list of private endpoint connections |
| PrivateEndpointConnections |
Interface representing a PrivateEndpointConnections. |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsListByDatabaseAccountOptionalParams |
Optional parameters. |
| PrivateEndpointProperty |
Private endpoint which the connection belongs to. |
| PrivateLinkResource |
A private link resource |
| PrivateLinkResourceListResult |
A list of private link resources |
| PrivateLinkResources |
Interface representing a PrivateLinkResources. |
| PrivateLinkResourcesGetOptionalParams |
Optional parameters. |
| PrivateLinkResourcesListByDatabaseAccountOptionalParams |
Optional parameters. |
| PrivateLinkServiceConnectionStateProperty |
Connection State of the Private Endpoint Connection. |
| Privilege |
The set of data plane operations permitted through this Role Definition. |
| PrivilegeResource |
An Azure Cosmos DB Mongo DB Resource. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| ProxyResourceAutoGenerated |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| RegionForOnlineOffline |
Cosmos DB region to online or offline. |
| RegionalServiceResource |
Resource for a regional service location. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceAutoGenerated |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceRestoreParameters |
Parameters to indicate the information about the restore. |
| RestorableDatabaseAccountGetResult |
A Azure Cosmos DB restorable database account. |
| RestorableDatabaseAccounts |
Interface representing a RestorableDatabaseAccounts. |
| RestorableDatabaseAccountsGetByLocationOptionalParams |
Optional parameters. |
| RestorableDatabaseAccountsListByLocationOptionalParams |
Optional parameters. |
| RestorableDatabaseAccountsListOptionalParams |
Optional parameters. |
| RestorableDatabaseAccountsListResult |
The List operation response, that contains the restorable database accounts and their properties. |
| RestorableGremlinDatabaseGetResult |
An Azure Cosmos DB Gremlin database event |
| RestorableGremlinDatabasePropertiesResource |
The resource of an Azure Cosmos DB Gremlin database event |
| RestorableGremlinDatabases |
Interface representing a RestorableGremlinDatabases. |
| RestorableGremlinDatabasesListOptionalParams |
Optional parameters. |
| RestorableGremlinDatabasesListResult |
The List operation response, that contains the Gremlin database events and their properties. |
| RestorableGremlinGraphGetResult |
An Azure Cosmos DB Gremlin graph event |
| RestorableGremlinGraphPropertiesResource |
The resource of an Azure Cosmos DB Gremlin graph event |
| RestorableGremlinGraphs |
Interface representing a RestorableGremlinGraphs. |
| RestorableGremlinGraphsListOptionalParams |
Optional parameters. |
| RestorableGremlinGraphsListResult |
The List operation response, that contains the Gremlin graph events and their properties. |
| RestorableGremlinResources |
Interface representing a RestorableGremlinResources. |
| RestorableGremlinResourcesGetResult |
Specific Databases to restore. |
| RestorableGremlinResourcesListOptionalParams |
Optional parameters. |
| RestorableGremlinResourcesListResult |
The List operation response, that contains the restorable Gremlin resources. |
| RestorableLocationResource |
Properties of the regional restorable account. |
| RestorableMongodbCollectionGetResult |
An Azure Cosmos DB MongoDB collection event |
| RestorableMongodbCollectionPropertiesResource |
The resource of an Azure Cosmos DB MongoDB collection event |
| RestorableMongodbCollections |
Interface representing a RestorableMongodbCollections. |
| RestorableMongodbCollectionsListOptionalParams |
Optional parameters. |
| RestorableMongodbCollectionsListResult |
The List operation response, that contains the MongoDB collection events and their properties. |
| RestorableMongodbDatabaseGetResult |
An Azure Cosmos DB MongoDB database event |
| RestorableMongodbDatabasePropertiesResource |
The resource of an Azure Cosmos DB MongoDB database event |
| RestorableMongodbDatabases |
Interface representing a RestorableMongodbDatabases. |
| RestorableMongodbDatabasesListOptionalParams |
Optional parameters. |
| RestorableMongodbDatabasesListResult |
The List operation response, that contains the MongoDB database events and their properties. |
| RestorableMongodbResources |
Interface representing a RestorableMongodbResources. |
| RestorableMongodbResourcesGetResult |
Specific Databases to restore. |
| RestorableMongodbResourcesListOptionalParams |
Optional parameters. |
| RestorableMongodbResourcesListResult |
The List operation response, that contains the restorable MongoDB resources. |
| RestorableSqlContainerGetResult |
An Azure Cosmos DB SQL container event |
| RestorableSqlContainerPropertiesResource |
The resource of an Azure Cosmos DB SQL container event |
| RestorableSqlContainerPropertiesResourceContainer |
Cosmos DB SQL container resource object |
| RestorableSqlContainers |
Interface representing a RestorableSqlContainers. |
| RestorableSqlContainersListOptionalParams |
Optional parameters. |
| RestorableSqlContainersListResult |
The List operation response, that contains the SQL container events and their properties. |
| RestorableSqlDatabaseGetResult |
An Azure Cosmos DB SQL database event |
| RestorableSqlDatabasePropertiesResource |
The resource of an Azure Cosmos DB SQL database event |
| RestorableSqlDatabasePropertiesResourceDatabase |
Cosmos DB SQL database resource object |
| RestorableSqlDatabases |
Interface representing a RestorableSqlDatabases. |
| RestorableSqlDatabasesListOptionalParams |
Optional parameters. |
| RestorableSqlDatabasesListResult |
The List operation response, that contains the SQL database events and their properties. |
| RestorableSqlResources |
Interface representing a RestorableSqlResources. |
| RestorableSqlResourcesGetResult |
Specific Databases to restore. |
| RestorableSqlResourcesListOptionalParams |
Optional parameters. |
| RestorableSqlResourcesListResult |
The List operation response, that contains the restorable SQL resources. |
| RestorableTableGetResult |
An Azure Cosmos DB Table event |
| RestorableTablePropertiesResource |
The resource of an Azure Cosmos DB Table event |
| RestorableTableResources |
Interface representing a RestorableTableResources. |
| RestorableTableResourcesGetResult |
Specific Databases to restore. |
| RestorableTableResourcesListOptionalParams |
Optional parameters. |
| RestorableTableResourcesListResult |
List of restorable table names. |
| RestorableTables |
Interface representing a RestorableTables. |
| RestorableTablesListOptionalParams |
Optional parameters. |
| RestorableTablesListResult |
The List operation response, that contains the Table events and their properties. |
| RestoreParameters |
Parameters to indicate the information about the restore. |
| RestoreParametersBase |
Parameters to indicate the information about the restore. |
| Role |
The set of roles permitted through this Role Definition. |
| SeedNode | |
| Service |
Interface representing a Service. |
| ServiceCreateHeaders |
Defines headers for Service_create operation. |
| ServiceCreateOptionalParams |
Optional parameters. |
| ServiceDeleteHeaders |
Defines headers for Service_delete operation. |
| ServiceDeleteOptionalParams |
Optional parameters. |
| ServiceGetOptionalParams |
Optional parameters. |
| ServiceListOptionalParams |
Optional parameters. |
| ServiceResource |
Properties for the database account. |
| ServiceResourceCreateUpdateParameters |
Parameters for Create or Update request for ServiceResource |
| ServiceResourceCreateUpdateProperties |
Properties in ServiceResourceCreateUpdateParameters. |
| ServiceResourceListResult |
The List operation response, that contains the Service Resource and their properties. |
| ServiceResourceProperties |
Services response resource. |
| SpatialSpec | |
| SqlContainerCreateUpdateParameters |
Parameters to create and update Cosmos DB container. |
| SqlContainerGetPropertiesOptions |
Cosmos DB options resource object |
| SqlContainerGetPropertiesResource |
Cosmos DB SQL container resource object |
| SqlContainerGetResults |
An Azure Cosmos DB container. |
| SqlContainerListResult |
The List operation response, that contains the containers and their properties. |
| SqlContainerResource |
Cosmos DB SQL container resource object |
| SqlDatabaseCreateUpdateParameters |
Parameters to create and update Cosmos DB SQL database. |
| SqlDatabaseGetPropertiesOptions |
Cosmos DB options resource object |
| SqlDatabaseGetPropertiesResource |
Cosmos DB SQL database resource object |
| SqlDatabaseGetResults |
An Azure Cosmos DB SQL database. |
| SqlDatabaseListResult |
The List operation response, that contains the SQL databases and their properties. |
| SqlDatabaseResource |
Cosmos DB SQL database resource object |
| SqlDedicatedGatewayRegionalServiceResource |
Resource for a regional service location. |
| SqlDedicatedGatewayServiceResource |
Describes the service response property for SqlDedicatedGateway. |
| SqlDedicatedGatewayServiceResourceCreateUpdateProperties |
Properties for Create or Update request for SqlDedicatedGatewayServiceResource |
| SqlDedicatedGatewayServiceResourceProperties |
Properties for SqlDedicatedGatewayServiceResource. |
| SqlResources |
Interface representing a SqlResources. |
| SqlResourcesCreateUpdateClientEncryptionKeyHeaders |
Defines headers for SqlResources_createUpdateClientEncryptionKey operation. |
| SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlContainerHeaders |
Defines headers for SqlResources_createUpdateSqlContainer operation. |
| SqlResourcesCreateUpdateSqlContainerOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlDatabaseHeaders |
Defines headers for SqlResources_createUpdateSqlDatabase operation. |
| SqlResourcesCreateUpdateSqlDatabaseOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlStoredProcedureHeaders |
Defines headers for SqlResources_createUpdateSqlStoredProcedure operation. |
| SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlTriggerHeaders |
Defines headers for SqlResources_createUpdateSqlTrigger operation. |
| SqlResourcesCreateUpdateSqlTriggerOptionalParams |
Optional parameters. |
| SqlResourcesCreateUpdateSqlUserDefinedFunctionHeaders |
Defines headers for SqlResources_createUpdateSqlUserDefinedFunction operation. |
| SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlContainerHeaders |
Defines headers for SqlResources_deleteSqlContainer operation. |
| SqlResourcesDeleteSqlContainerOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlDatabaseHeaders |
Defines headers for SqlResources_deleteSqlDatabase operation. |
| SqlResourcesDeleteSqlDatabaseOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlRoleAssignmentOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlRoleDefinitionOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlStoredProcedureHeaders |
Defines headers for SqlResources_deleteSqlStoredProcedure operation. |
| SqlResourcesDeleteSqlStoredProcedureOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlTriggerHeaders |
Defines headers for SqlResources_deleteSqlTrigger operation. |
| SqlResourcesDeleteSqlTriggerOptionalParams |
Optional parameters. |
| SqlResourcesDeleteSqlUserDefinedFunctionHeaders |
Defines headers for SqlResources_deleteSqlUserDefinedFunction operation. |
| SqlResourcesDeleteSqlUserDefinedFunctionOptionalParams |
Optional parameters. |
| SqlResourcesGetClientEncryptionKeyOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlContainerOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlContainerThroughputOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlDatabaseOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlDatabaseThroughputOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlRoleAssignmentOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlRoleDefinitionOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlStoredProcedureOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlTriggerOptionalParams |
Optional parameters. |
| SqlResourcesGetSqlUserDefinedFunctionOptionalParams |
Optional parameters. |
| SqlResourcesListClientEncryptionKeysOptionalParams |
Optional parameters. |
| SqlResourcesListSqlContainersOptionalParams |
Optional parameters. |
| SqlResourcesListSqlDatabasesOptionalParams |
Optional parameters. |
| SqlResourcesListSqlRoleAssignmentsOptionalParams |
Optional parameters. |
| SqlResourcesListSqlRoleDefinitionsOptionalParams |
Optional parameters. |
| SqlResourcesListSqlStoredProceduresOptionalParams |
Optional parameters. |
| SqlResourcesListSqlTriggersOptionalParams |
Optional parameters. |
| SqlResourcesListSqlUserDefinedFunctionsOptionalParams |
Optional parameters. |
| SqlResourcesMigrateSqlContainerToAutoscaleHeaders |
Defines headers for SqlResources_migrateSqlContainerToAutoscale operation. |
| SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams |
Optional parameters. |
| SqlResourcesMigrateSqlContainerToManualThroughputHeaders |
Defines headers for SqlResources_migrateSqlContainerToManualThroughput operation. |
| SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams |
Optional parameters. |
| SqlResourcesMigrateSqlDatabaseToAutoscaleHeaders |
Defines headers for SqlResources_migrateSqlDatabaseToAutoscale operation. |
| SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams |
Optional parameters. |
| SqlResourcesMigrateSqlDatabaseToManualThroughputHeaders |
Defines headers for SqlResources_migrateSqlDatabaseToManualThroughput operation. |
| SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams |
Optional parameters. |
| SqlResourcesRetrieveContinuousBackupInformationOptionalParams |
Optional parameters. |
| SqlResourcesUpdateSqlContainerThroughputHeaders |
Defines headers for SqlResources_updateSqlContainerThroughput operation. |
| SqlResourcesUpdateSqlContainerThroughputOptionalParams |
Optional parameters. |
| SqlResourcesUpdateSqlDatabaseThroughputHeaders |
Defines headers for SqlResources_updateSqlDatabaseThroughput operation. |
| SqlResourcesUpdateSqlDatabaseThroughputOptionalParams |
Optional parameters. |
| SqlRoleAssignmentCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB SQL Role Assignment. |
| SqlRoleAssignmentGetResults |
An Azure Cosmos DB Role Assignment |
| SqlRoleAssignmentListResult |
The relevant Role Assignments. |
| SqlRoleDefinitionCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB SQL Role Definition. |
| SqlRoleDefinitionGetResults |
An Azure Cosmos DB SQL Role Definition. |
| SqlRoleDefinitionListResult |
The relevant Role Definitions. |
| SqlStoredProcedureCreateUpdateParameters |
Parameters to create and update Cosmos DB storedProcedure. |
| SqlStoredProcedureGetPropertiesResource |
Cosmos DB SQL storedProcedure resource object |
| SqlStoredProcedureGetResults |
An Azure Cosmos DB storedProcedure. |
| SqlStoredProcedureListResult |
The List operation response, that contains the storedProcedures and their properties. |
| SqlStoredProcedureResource |
Cosmos DB SQL storedProcedure resource object |
| SqlTriggerCreateUpdateParameters |
Parameters to create and update Cosmos DB trigger. |
| SqlTriggerGetPropertiesResource |
Cosmos DB SQL trigger resource object |
| SqlTriggerGetResults |
An Azure Cosmos DB trigger. |
| SqlTriggerListResult |
The List operation response, that contains the triggers and their properties. |
| SqlTriggerResource |
Cosmos DB SQL trigger resource object |
| SqlUserDefinedFunctionCreateUpdateParameters |
Parameters to create and update Cosmos DB userDefinedFunction. |
| SqlUserDefinedFunctionGetPropertiesResource |
Cosmos DB SQL userDefinedFunction resource object |
| SqlUserDefinedFunctionGetResults |
An Azure Cosmos DB userDefinedFunction. |
| SqlUserDefinedFunctionListResult |
The List operation response, that contains the userDefinedFunctions and their properties. |
| SqlUserDefinedFunctionResource |
Cosmos DB SQL userDefinedFunction resource object |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TableCreateUpdateParameters |
Parameters to create and update Cosmos DB Table. |
| TableGetPropertiesOptions |
Cosmos DB options resource object |
| TableGetPropertiesResource |
Cosmos DB table resource object |
| TableGetResults |
An Azure Cosmos DB Table. |
| TableListResult |
The List operation response, that contains the Table and their properties. |
| TableResource |
Cosmos DB table resource object |
| TableResources |
Interface representing a TableResources. |
| TableResourcesCreateUpdateTableHeaders |
Defines headers for TableResources_createUpdateTable operation. |
| TableResourcesCreateUpdateTableOptionalParams |
Optional parameters. |
| TableResourcesDeleteTableHeaders |
Defines headers for TableResources_deleteTable operation. |
| TableResourcesDeleteTableOptionalParams |
Optional parameters. |
| TableResourcesGetTableOptionalParams |
Optional parameters. |
| TableResourcesGetTableThroughputOptionalParams |
Optional parameters. |
| TableResourcesListTablesOptionalParams |
Optional parameters. |
| TableResourcesMigrateTableToAutoscaleHeaders |
Defines headers for TableResources_migrateTableToAutoscale operation. |
| TableResourcesMigrateTableToAutoscaleOptionalParams |
Optional parameters. |
| TableResourcesMigrateTableToManualThroughputHeaders |
Defines headers for TableResources_migrateTableToManualThroughput operation. |
| TableResourcesMigrateTableToManualThroughputOptionalParams |
Optional parameters. |
| TableResourcesRetrieveContinuousBackupInformationOptionalParams |
Optional parameters. |
| TableResourcesUpdateTableThroughputHeaders |
Defines headers for TableResources_updateTableThroughput operation. |
| TableResourcesUpdateTableThroughputOptionalParams |
Optional parameters. |
| ThroughputPolicyResource |
Cosmos DB resource throughput policy |
| ThroughputSettingsGetPropertiesResource |
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
| ThroughputSettingsGetResults |
An Azure Cosmos DB resource throughput. |
| ThroughputSettingsResource |
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
| ThroughputSettingsUpdateParameters |
Parameters to update Cosmos DB resource throughput. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UniqueKey |
The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. |
| UniqueKeyPolicy |
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. |
| UsagesResult |
The response to a list usage request. |
| VectorEmbedding |
Represents a vector embedding. A vector embedding is used to define a vector field in the documents. |
| VectorEmbeddingPolicy |
Cosmos DB Vector Embedding Policy |
| VectorIndex | |
| VirtualNetworkRule |
Virtual Network ACL Rule object |
Type Aliases
| AnalyticalStorageSchemaType |
Defines values for AnalyticalStorageSchemaType. Known values supported by the serviceWellDefined |
| ApiType |
Defines values for ApiType. Known values supported by the serviceMongoDB |
| AuthenticationMethod |
Defines values for AuthenticationMethod. Known values supported by the serviceNone |
| AzureConnectionType |
Defines values for AzureConnectionType. Known values supported by the serviceNone |
| BackupPolicyMigrationStatus |
Defines values for BackupPolicyMigrationStatus. Known values supported by the serviceInvalid |
| BackupPolicyType |
Defines values for BackupPolicyType. Known values supported by the servicePeriodic |
| BackupPolicyUnion | |
| BackupStorageRedundancy |
Defines values for BackupStorageRedundancy. Known values supported by the serviceGeo |
| CassandraClustersCreateUpdateResponse |
Contains response data for the createUpdate operation. |
| CassandraClustersGetResponse |
Contains response data for the get operation. |
| CassandraClustersInvokeCommandResponse |
Contains response data for the invokeCommand operation. |
| CassandraClustersListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| CassandraClustersListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| CassandraClustersStatusResponse |
Contains response data for the status operation. |
| CassandraClustersUpdateResponse |
Contains response data for the update operation. |
| CassandraDataCentersCreateUpdateResponse |
Contains response data for the createUpdate operation. |
| CassandraDataCentersGetResponse |
Contains response data for the get operation. |
| CassandraDataCentersListResponse |
Contains response data for the list operation. |
| CassandraDataCentersUpdateResponse |
Contains response data for the update operation. |
| CassandraResourcesCreateUpdateCassandraKeyspaceResponse |
Contains response data for the createUpdateCassandraKeyspace operation. |
| CassandraResourcesCreateUpdateCassandraTableResponse |
Contains response data for the createUpdateCassandraTable operation. |
| CassandraResourcesDeleteCassandraKeyspaceResponse |
Contains response data for the deleteCassandraKeyspace operation. |
| CassandraResourcesDeleteCassandraTableResponse |
Contains response data for the deleteCassandraTable operation. |
| CassandraResourcesGetCassandraKeyspaceResponse |
Contains response data for the getCassandraKeyspace operation. |
| CassandraResourcesGetCassandraKeyspaceThroughputResponse |
Contains response data for the getCassandraKeyspaceThroughput operation. |
| CassandraResourcesGetCassandraTableResponse |
Contains response data for the getCassandraTable operation. |
| CassandraResourcesGetCassandraTableThroughputResponse |
Contains response data for the getCassandraTableThroughput operation. |
| CassandraResourcesListCassandraKeyspacesResponse |
Contains response data for the listCassandraKeyspaces operation. |
| CassandraResourcesListCassandraTablesResponse |
Contains response data for the listCassandraTables operation. |
| CassandraResourcesMigrateCassandraKeyspaceToAutoscaleResponse |
Contains response data for the migrateCassandraKeyspaceToAutoscale operation. |
| CassandraResourcesMigrateCassandraKeyspaceToManualThroughputResponse |
Contains response data for the migrateCassandraKeyspaceToManualThroughput operation. |
| CassandraResourcesMigrateCassandraTableToAutoscaleResponse |
Contains response data for the migrateCassandraTableToAutoscale operation. |
| CassandraResourcesMigrateCassandraTableToManualThroughputResponse |
Contains response data for the migrateCassandraTableToManualThroughput operation. |
| CassandraResourcesUpdateCassandraKeyspaceThroughputResponse |
Contains response data for the updateCassandraKeyspaceThroughput operation. |
| CassandraResourcesUpdateCassandraTableThroughputResponse |
Contains response data for the updateCassandraTableThroughput operation. |
| CollectionListMetricDefinitionsResponse |
Contains response data for the listMetricDefinitions operation. |
| CollectionListMetricsResponse |
Contains response data for the listMetrics operation. |
| CollectionListUsagesResponse |
Contains response data for the listUsages operation. |
| CollectionPartitionListMetricsResponse |
Contains response data for the listMetrics operation. |
| CollectionPartitionListUsagesResponse |
Contains response data for the listUsages operation. |
| CollectionPartitionRegionListMetricsResponse |
Contains response data for the listMetrics operation. |
| CollectionRegionListMetricsResponse |
Contains response data for the listMetrics operation. |
| CompositePathSortOrder |
Defines values for CompositePathSortOrder. Known values supported by the serviceascending |
| ConflictResolutionMode |
Defines values for ConflictResolutionMode. Known values supported by the serviceLastWriterWins |
| ConnectionState |
Defines values for ConnectionState. Known values supported by the serviceUnknown |
| ConnectorOffer |
Defines values for ConnectorOffer. Known values supported by the serviceSmall |
| ContinuousTier |
Defines values for ContinuousTier. Known values supported by the serviceContinuous7Days |
| CreateMode |
Defines values for CreateMode. Known values supported by the serviceDefault |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DataType |
Defines values for DataType. Known values supported by the serviceString |
| DatabaseAccountKind |
Defines values for DatabaseAccountKind. Known values supported by the serviceGlobalDocumentDB |
| DatabaseAccountRegionListMetricsResponse |
Contains response data for the listMetrics operation. |
| DatabaseAccountsCheckNameExistsResponse |
Contains response data for the checkNameExists operation. |
| DatabaseAccountsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| DatabaseAccountsDeleteResponse |
Contains response data for the delete operation. |
| DatabaseAccountsFailoverPriorityChangeResponse |
Contains response data for the failoverPriorityChange operation. |
| DatabaseAccountsGetReadOnlyKeysResponse |
Contains response data for the getReadOnlyKeys operation. |
| DatabaseAccountsGetResponse |
Contains response data for the get operation. |
| DatabaseAccountsListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| DatabaseAccountsListConnectionStringsResponse |
Contains response data for the listConnectionStrings operation. |
| DatabaseAccountsListKeysResponse |
Contains response data for the listKeys operation. |
| DatabaseAccountsListMetricDefinitionsResponse |
Contains response data for the listMetricDefinitions operation. |
| DatabaseAccountsListMetricsResponse |
Contains response data for the listMetrics operation. |
| DatabaseAccountsListReadOnlyKeysResponse |
Contains response data for the listReadOnlyKeys operation. |
| DatabaseAccountsListResponse |
Contains response data for the list operation. |
| DatabaseAccountsListUsagesResponse |
Contains response data for the listUsages operation. |
| DatabaseAccountsUpdateResponse |
Contains response data for the update operation. |
| DatabaseListMetricDefinitionsResponse |
Contains response data for the listMetricDefinitions operation. |
| DatabaseListMetricsResponse |
Contains response data for the listMetrics operation. |
| DatabaseListUsagesResponse |
Contains response data for the listUsages operation. |
| DedicatedGatewayType |
Defines values for DedicatedGatewayType. Known values supported by the serviceIntegratedCache |
| DefaultConsistencyLevel |
Defines values for DefaultConsistencyLevel. |
| DefaultPriorityLevel |
Defines values for DefaultPriorityLevel. Known values supported by the serviceHigh |
| DistanceFunction |
Defines values for DistanceFunction. Known values supported by the serviceeuclidean |
| FleetCreateResponse |
Contains response data for the create operation. |
| FleetDeleteResponse |
Contains response data for the delete operation. |
| FleetGetResponse |
Contains response data for the get operation. |
| FleetListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| FleetListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| FleetListNextResponse |
Contains response data for the listNext operation. |
| FleetListResponse |
Contains response data for the list operation. |
| FleetUpdateResponse |
Contains response data for the update operation. |
| FleetspaceAccountCreateResponse |
Contains response data for the create operation. |
| FleetspaceAccountDeleteResponse |
Contains response data for the delete operation. |
| FleetspaceAccountGetResponse |
Contains response data for the get operation. |
| FleetspaceAccountListNextResponse |
Contains response data for the listNext operation. |
| FleetspaceAccountListResponse |
Contains response data for the list operation. |
| FleetspaceCreateResponse |
Contains response data for the create operation. |
| FleetspaceDeleteResponse |
Contains response data for the delete operation. |
| FleetspaceGetResponse |
Contains response data for the get operation. |
| FleetspaceListNextResponse |
Contains response data for the listNext operation. |
| FleetspaceListResponse |
Contains response data for the list operation. |
| FleetspacePropertiesFleetspaceApiKind |
Defines values for FleetspacePropertiesFleetspaceApiKind. Known values supported by the serviceNoSQL |
| FleetspacePropertiesServiceTier |
Defines values for FleetspacePropertiesServiceTier. Known values supported by the serviceGeneralPurpose |
| FleetspaceUpdateResponse |
Contains response data for the update operation. |
| GremlinResourcesCreateUpdateGremlinDatabaseResponse |
Contains response data for the createUpdateGremlinDatabase operation. |
| GremlinResourcesCreateUpdateGremlinGraphResponse |
Contains response data for the createUpdateGremlinGraph operation. |
| GremlinResourcesDeleteGremlinDatabaseResponse |
Contains response data for the deleteGremlinDatabase operation. |
| GremlinResourcesDeleteGremlinGraphResponse |
Contains response data for the deleteGremlinGraph operation. |
| GremlinResourcesGetGremlinDatabaseResponse |
Contains response data for the getGremlinDatabase operation. |
| GremlinResourcesGetGremlinDatabaseThroughputResponse |
Contains response data for the getGremlinDatabaseThroughput operation. |
| GremlinResourcesGetGremlinGraphResponse |
Contains response data for the getGremlinGraph operation. |
| GremlinResourcesGetGremlinGraphThroughputResponse |
Contains response data for the getGremlinGraphThroughput operation. |
| GremlinResourcesListGremlinDatabasesResponse |
Contains response data for the listGremlinDatabases operation. |
| GremlinResourcesListGremlinGraphsResponse |
Contains response data for the listGremlinGraphs operation. |
| GremlinResourcesMigrateGremlinDatabaseToAutoscaleResponse |
Contains response data for the migrateGremlinDatabaseToAutoscale operation. |
| GremlinResourcesMigrateGremlinDatabaseToManualThroughputResponse |
Contains response data for the migrateGremlinDatabaseToManualThroughput operation. |
| GremlinResourcesMigrateGremlinGraphToAutoscaleResponse |
Contains response data for the migrateGremlinGraphToAutoscale operation. |
| GremlinResourcesMigrateGremlinGraphToManualThroughputResponse |
Contains response data for the migrateGremlinGraphToManualThroughput operation. |
| GremlinResourcesRetrieveContinuousBackupInformationResponse |
Contains response data for the retrieveContinuousBackupInformation operation. |
| GremlinResourcesUpdateGremlinDatabaseThroughputResponse |
Contains response data for the updateGremlinDatabaseThroughput operation. |
| GremlinResourcesUpdateGremlinGraphThroughputResponse |
Contains response data for the updateGremlinGraphThroughput operation. |
| IndexKind |
Defines values for IndexKind. Known values supported by the serviceHash |
| IndexingMode |
Defines values for IndexingMode. Known values supported by the serviceconsistent |
| KeyKind |
Defines values for KeyKind. Known values supported by the serviceprimary |
| Kind |
Defines values for Kind. Known values supported by the servicePrimary |
| LocationsGetResponse |
Contains response data for the get operation. |
| LocationsListResponse |
Contains response data for the list operation. |
| ManagedCassandraProvisioningState |
Defines values for ManagedCassandraProvisioningState. Known values supported by the serviceCreating |
| ManagedCassandraResourceIdentityType |
Defines values for ManagedCassandraResourceIdentityType. Known values supported by the serviceSystemAssigned |
| MinimalTlsVersion |
Defines values for MinimalTlsVersion. Known values supported by the serviceTls |
| MongoDBResourcesCreateUpdateMongoDBCollectionResponse |
Contains response data for the createUpdateMongoDBCollection operation. |
| MongoDBResourcesCreateUpdateMongoDBDatabaseResponse |
Contains response data for the createUpdateMongoDBDatabase operation. |
| MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse |
Contains response data for the createUpdateMongoRoleDefinition operation. |
| MongoDBResourcesCreateUpdateMongoUserDefinitionResponse |
Contains response data for the createUpdateMongoUserDefinition operation. |
| MongoDBResourcesDeleteMongoDBCollectionResponse |
Contains response data for the deleteMongoDBCollection operation. |
| MongoDBResourcesDeleteMongoDBDatabaseResponse |
Contains response data for the deleteMongoDBDatabase operation. |
| MongoDBResourcesGetMongoDBCollectionResponse |
Contains response data for the getMongoDBCollection operation. |
| MongoDBResourcesGetMongoDBCollectionThroughputResponse |
Contains response data for the getMongoDBCollectionThroughput operation. |
| MongoDBResourcesGetMongoDBDatabaseResponse |
Contains response data for the getMongoDBDatabase operation. |
| MongoDBResourcesGetMongoDBDatabaseThroughputResponse |
Contains response data for the getMongoDBDatabaseThroughput operation. |
| MongoDBResourcesGetMongoRoleDefinitionResponse |
Contains response data for the getMongoRoleDefinition operation. |
| MongoDBResourcesGetMongoUserDefinitionResponse |
Contains response data for the getMongoUserDefinition operation. |
| MongoDBResourcesListMongoDBCollectionsResponse |
Contains response data for the listMongoDBCollections operation. |
| MongoDBResourcesListMongoDBDatabasesResponse |
Contains response data for the listMongoDBDatabases operation. |
| MongoDBResourcesListMongoRoleDefinitionsResponse |
Contains response data for the listMongoRoleDefinitions operation. |
| MongoDBResourcesListMongoUserDefinitionsResponse |
Contains response data for the listMongoUserDefinitions operation. |
| MongoDBResourcesMigrateMongoDBCollectionToAutoscaleResponse |
Contains response data for the migrateMongoDBCollectionToAutoscale operation. |
| MongoDBResourcesMigrateMongoDBCollectionToManualThroughputResponse |
Contains response data for the migrateMongoDBCollectionToManualThroughput operation. |
| MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleResponse |
Contains response data for the migrateMongoDBDatabaseToAutoscale operation. |
| MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputResponse |
Contains response data for the migrateMongoDBDatabaseToManualThroughput operation. |
| MongoDBResourcesRetrieveContinuousBackupInformationResponse |
Contains response data for the retrieveContinuousBackupInformation operation. |
| MongoDBResourcesUpdateMongoDBCollectionThroughputResponse |
Contains response data for the updateMongoDBCollectionThroughput operation. |
| MongoDBResourcesUpdateMongoDBDatabaseThroughputResponse |
Contains response data for the updateMongoDBDatabaseThroughput operation. |
| MongoRoleDefinitionType |
Defines values for MongoRoleDefinitionType. |
| NetworkAclBypass |
Defines values for NetworkAclBypass. |
| NodeState |
Defines values for NodeState. Known values supported by the serviceNormal |
| NodeStatus |
Defines values for NodeStatus. Known values supported by the serviceUp |
| NotebookWorkspaceName |
Defines values for NotebookWorkspaceName. Known values supported by the servicedefault |
| NotebookWorkspacesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| NotebookWorkspacesGetResponse |
Contains response data for the get operation. |
| NotebookWorkspacesListByDatabaseAccountResponse |
Contains response data for the listByDatabaseAccount operation. |
| NotebookWorkspacesListConnectionInfoResponse |
Contains response data for the listConnectionInfo operation. |
| OperationType |
Defines values for OperationType. Known values supported by the serviceCreate |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| PartitionKeyRangeIdListMetricsResponse |
Contains response data for the listMetrics operation. |
| PartitionKeyRangeIdRegionListMetricsResponse |
Contains response data for the listMetrics operation. |
| PartitionKind |
Defines values for PartitionKind. Known values supported by the serviceHash |
| PercentileListMetricsResponse |
Contains response data for the listMetrics operation. |
| PercentileSourceTargetListMetricsResponse |
Contains response data for the listMetrics operation. |
| PercentileTargetListMetricsResponse |
Contains response data for the listMetrics operation. |
| PrimaryAggregationType |
Defines values for PrimaryAggregationType. Known values supported by the serviceNone |
| PrivateEndpointConnectionsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| PrivateEndpointConnectionsGetResponse |
Contains response data for the get operation. |
| PrivateEndpointConnectionsListByDatabaseAccountResponse |
Contains response data for the listByDatabaseAccount operation. |
| PrivateLinkResourcesGetResponse |
Contains response data for the get operation. |
| PrivateLinkResourcesListByDatabaseAccountResponse |
Contains response data for the listByDatabaseAccount operation. |
| PublicNetworkAccess |
Defines values for PublicNetworkAccess. Known values supported by the serviceEnabled |
| ResourceIdentityType |
Defines values for ResourceIdentityType. |
| RestorableDatabaseAccountsGetByLocationResponse |
Contains response data for the getByLocation operation. |
| RestorableDatabaseAccountsListByLocationResponse |
Contains response data for the listByLocation operation. |
| RestorableDatabaseAccountsListResponse |
Contains response data for the list operation. |
| RestorableGremlinDatabasesListResponse |
Contains response data for the list operation. |
| RestorableGremlinGraphsListResponse |
Contains response data for the list operation. |
| RestorableGremlinResourcesListResponse |
Contains response data for the list operation. |
| RestorableMongodbCollectionsListResponse |
Contains response data for the list operation. |
| RestorableMongodbDatabasesListResponse |
Contains response data for the list operation. |
| RestorableMongodbResourcesListResponse |
Contains response data for the list operation. |
| RestorableSqlContainersListResponse |
Contains response data for the list operation. |
| RestorableSqlDatabasesListResponse |
Contains response data for the list operation. |
| RestorableSqlResourcesListResponse |
Contains response data for the list operation. |
| RestorableTableResourcesListResponse |
Contains response data for the list operation. |
| RestorableTablesListResponse |
Contains response data for the list operation. |
| RestoreMode |
Defines values for RestoreMode. Known values supported by the servicePointInTime |
| RoleDefinitionType |
Defines values for RoleDefinitionType. |
| ServerVersion |
Defines values for ServerVersion. Known values supported by the service3.2 |
| ServiceCreateResponse |
Contains response data for the create operation. |
| ServiceGetResponse |
Contains response data for the get operation. |
| ServiceListResponse |
Contains response data for the list operation. |
| ServiceResourceCreateUpdatePropertiesUnion | |
| ServiceResourcePropertiesUnion | |
| ServiceSize |
Defines values for ServiceSize. Known values supported by the serviceCosmos.D4s |
| ServiceStatus |
Defines values for ServiceStatus. Known values supported by the serviceCreating |
| ServiceType |
Defines values for ServiceType. Known values supported by the serviceSqlDedicatedGateway |
| SpatialType |
Defines values for SpatialType. Known values supported by the servicePoint |
| SqlResourcesCreateUpdateClientEncryptionKeyResponse |
Contains response data for the createUpdateClientEncryptionKey operation. |
| SqlResourcesCreateUpdateSqlContainerResponse |
Contains response data for the createUpdateSqlContainer operation. |
| SqlResourcesCreateUpdateSqlDatabaseResponse |
Contains response data for the createUpdateSqlDatabase operation. |
| SqlResourcesCreateUpdateSqlRoleAssignmentResponse |
Contains response data for the createUpdateSqlRoleAssignment operation. |
| SqlResourcesCreateUpdateSqlRoleDefinitionResponse |
Contains response data for the createUpdateSqlRoleDefinition operation. |
| SqlResourcesCreateUpdateSqlStoredProcedureResponse |
Contains response data for the createUpdateSqlStoredProcedure operation. |
| SqlResourcesCreateUpdateSqlTriggerResponse |
Contains response data for the createUpdateSqlTrigger operation. |
| SqlResourcesCreateUpdateSqlUserDefinedFunctionResponse |
Contains response data for the createUpdateSqlUserDefinedFunction operation. |
| SqlResourcesDeleteSqlContainerResponse |
Contains response data for the deleteSqlContainer operation. |
| SqlResourcesDeleteSqlDatabaseResponse |
Contains response data for the deleteSqlDatabase operation. |
| SqlResourcesDeleteSqlStoredProcedureResponse |
Contains response data for the deleteSqlStoredProcedure operation. |
| SqlResourcesDeleteSqlTriggerResponse |
Contains response data for the deleteSqlTrigger operation. |
| SqlResourcesDeleteSqlUserDefinedFunctionResponse |
Contains response data for the deleteSqlUserDefinedFunction operation. |
| SqlResourcesGetClientEncryptionKeyResponse |
Contains response data for the getClientEncryptionKey operation. |
| SqlResourcesGetSqlContainerResponse |
Contains response data for the getSqlContainer operation. |
| SqlResourcesGetSqlContainerThroughputResponse |
Contains response data for the getSqlContainerThroughput operation. |
| SqlResourcesGetSqlDatabaseResponse |
Contains response data for the getSqlDatabase operation. |
| SqlResourcesGetSqlDatabaseThroughputResponse |
Contains response data for the getSqlDatabaseThroughput operation. |
| SqlResourcesGetSqlRoleAssignmentResponse |
Contains response data for the getSqlRoleAssignment operation. |
| SqlResourcesGetSqlRoleDefinitionResponse |
Contains response data for the getSqlRoleDefinition operation. |
| SqlResourcesGetSqlStoredProcedureResponse |
Contains response data for the getSqlStoredProcedure operation. |
| SqlResourcesGetSqlTriggerResponse |
Contains response data for the getSqlTrigger operation. |
| SqlResourcesGetSqlUserDefinedFunctionResponse |
Contains response data for the getSqlUserDefinedFunction operation. |
| SqlResourcesListClientEncryptionKeysResponse |
Contains response data for the listClientEncryptionKeys operation. |
| SqlResourcesListSqlContainersResponse |
Contains response data for the listSqlContainers operation. |
| SqlResourcesListSqlDatabasesResponse |
Contains response data for the listSqlDatabases operation. |
| SqlResourcesListSqlRoleAssignmentsResponse |
Contains response data for the listSqlRoleAssignments operation. |
| SqlResourcesListSqlRoleDefinitionsResponse |
Contains response data for the listSqlRoleDefinitions operation. |
| SqlResourcesListSqlStoredProceduresResponse |
Contains response data for the listSqlStoredProcedures operation. |
| SqlResourcesListSqlTriggersResponse |
Contains response data for the listSqlTriggers operation. |
| SqlResourcesListSqlUserDefinedFunctionsResponse |
Contains response data for the listSqlUserDefinedFunctions operation. |
| SqlResourcesMigrateSqlContainerToAutoscaleResponse |
Contains response data for the migrateSqlContainerToAutoscale operation. |
| SqlResourcesMigrateSqlContainerToManualThroughputResponse |
Contains response data for the migrateSqlContainerToManualThroughput operation. |
| SqlResourcesMigrateSqlDatabaseToAutoscaleResponse |
Contains response data for the migrateSqlDatabaseToAutoscale operation. |
| SqlResourcesMigrateSqlDatabaseToManualThroughputResponse |
Contains response data for the migrateSqlDatabaseToManualThroughput operation. |
| SqlResourcesRetrieveContinuousBackupInformationResponse |
Contains response data for the retrieveContinuousBackupInformation operation. |
| SqlResourcesUpdateSqlContainerThroughputResponse |
Contains response data for the updateSqlContainerThroughput operation. |
| SqlResourcesUpdateSqlDatabaseThroughputResponse |
Contains response data for the updateSqlDatabaseThroughput operation. |
| Status |
Defines values for Status. Known values supported by the serviceUninitialized |
| TableResourcesCreateUpdateTableResponse |
Contains response data for the createUpdateTable operation. |
| TableResourcesDeleteTableResponse |
Contains response data for the deleteTable operation. |
| TableResourcesGetTableResponse |
Contains response data for the getTable operation. |
| TableResourcesGetTableThroughputResponse |
Contains response data for the getTableThroughput operation. |
| TableResourcesListTablesResponse |
Contains response data for the listTables operation. |
| TableResourcesMigrateTableToAutoscaleResponse |
Contains response data for the migrateTableToAutoscale operation. |
| TableResourcesMigrateTableToManualThroughputResponse |
Contains response data for the migrateTableToManualThroughput operation. |
| TableResourcesRetrieveContinuousBackupInformationResponse |
Contains response data for the retrieveContinuousBackupInformation operation. |
| TableResourcesUpdateTableThroughputResponse |
Contains response data for the updateTableThroughput operation. |
| TriggerOperation |
Defines values for TriggerOperation. Known values supported by the serviceAll |
| TriggerType |
Defines values for TriggerType. Known values supported by the servicePre |
| Type |
Defines values for Type. Known values supported by the serviceSql |
| UnitType |
Defines values for UnitType. Known values supported by the serviceCount |
| VectorDataType |
Defines values for VectorDataType. Known values supported by the servicefloat32 |
| VectorIndexType |
Defines values for VectorIndexType. Known values supported by the serviceflat |
Enums
| KnownAnalyticalStorageSchemaType |
Known values of AnalyticalStorageSchemaType that the service accepts. |
| KnownApiType |
Known values of ApiType that the service accepts. |
| KnownAuthenticationMethod |
Known values of AuthenticationMethod that the service accepts. |
| KnownAzureConnectionType |
Known values of AzureConnectionType that the service accepts. |
| KnownBackupPolicyMigrationStatus |
Known values of BackupPolicyMigrationStatus that the service accepts. |
| KnownBackupPolicyType |
Known values of BackupPolicyType that the service accepts. |
| KnownBackupStorageRedundancy |
Known values of BackupStorageRedundancy that the service accepts. |
| KnownCompositePathSortOrder |
Known values of CompositePathSortOrder that the service accepts. |
| KnownConflictResolutionMode |
Known values of ConflictResolutionMode that the service accepts. |
| KnownConnectionState |
Known values of ConnectionState that the service accepts. |
| KnownConnectorOffer |
Known values of ConnectorOffer that the service accepts. |
| KnownContinuousTier |
Known values of ContinuousTier that the service accepts. |
| KnownCreateMode |
Known values of CreateMode that the service accepts. |
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownDataType |
Known values of DataType that the service accepts. |
| KnownDatabaseAccountKind |
Known values of DatabaseAccountKind that the service accepts. |
| KnownDedicatedGatewayType |
Known values of DedicatedGatewayType that the service accepts. |
| KnownDefaultPriorityLevel |
Known values of DefaultPriorityLevel that the service accepts. |
| KnownDistanceFunction |
Known values of DistanceFunction that the service accepts. |
| KnownFleetspacePropertiesFleetspaceApiKind |
Known values of FleetspacePropertiesFleetspaceApiKind that the service accepts. |
| KnownFleetspacePropertiesServiceTier |
Known values of FleetspacePropertiesServiceTier that the service accepts. |
| KnownIndexKind |
Known values of IndexKind that the service accepts. |
| KnownIndexingMode |
Known values of IndexingMode that the service accepts. |
| KnownKeyKind |
Known values of KeyKind that the service accepts. |
| KnownKind |
Known values of Kind that the service accepts. |
| KnownManagedCassandraProvisioningState |
Known values of ManagedCassandraProvisioningState that the service accepts. |
| KnownManagedCassandraResourceIdentityType |
Known values of ManagedCassandraResourceIdentityType that the service accepts. |
| KnownMinimalTlsVersion |
Known values of MinimalTlsVersion that the service accepts. |
| KnownNodeState |
Known values of NodeState that the service accepts. |
| KnownNodeStatus |
Known values of NodeStatus that the service accepts. |
| KnownNotebookWorkspaceName |
Known values of NotebookWorkspaceName that the service accepts. |
| KnownOperationType |
Known values of OperationType that the service accepts. |
| KnownPartitionKind |
Known values of PartitionKind that the service accepts. |
| KnownPrimaryAggregationType |
Known values of PrimaryAggregationType that the service accepts. |
| KnownPublicNetworkAccess |
Known values of PublicNetworkAccess that the service accepts. |
| KnownRestoreMode |
Known values of RestoreMode that the service accepts. |
| KnownServerVersion |
Known values of ServerVersion that the service accepts. |
| KnownServiceSize |
Known values of ServiceSize that the service accepts. |
| KnownServiceStatus |
Known values of ServiceStatus that the service accepts. |
| KnownServiceType |
Known values of ServiceType that the service accepts. |
| KnownSpatialType |
Known values of SpatialType that the service accepts. |
| KnownStatus |
Known values of Status that the service accepts. |
| KnownTriggerOperation |
Known values of TriggerOperation that the service accepts. |
| KnownTriggerType |
Known values of TriggerType that the service accepts. |
| KnownType |
Known values of Type that the service accepts. |
| KnownUnitType |
Known values of UnitType that the service accepts. |
| KnownVectorDataType |
Known values of VectorDataType that the service accepts. |
| KnownVectorIndexType |
Known values of VectorIndexType that the service accepts. |
Functions
| get |
Given the last |
Function Details
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.