@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

AzureBlobDataTransferDataSourceSink

An Azure Blob Storage data source/sink

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.

BackupResource

A restorable backup of a Cassandra cluster.

BackupResourceProperties
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.

CassandraClustersGetBackupOptionalParams

Optional parameters.

CassandraClustersGetOptionalParams

Optional parameters.

CassandraClustersInvokeCommandOptionalParams

Optional parameters.

CassandraClustersListBackupsOptionalParams

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.

CassandraKeyspaceCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra keyspace.

CassandraKeyspaceGetPropertiesOptions
CassandraKeyspaceGetPropertiesResource
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.

CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams

Optional parameters.

CassandraResourcesCreateUpdateCassandraTableOptionalParams

Optional parameters.

CassandraResourcesCreateUpdateCassandraViewOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraKeyspaceOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraTableOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraViewOptionalParams

Optional parameters.

CassandraResourcesGetCassandraKeyspaceOptionalParams

Optional parameters.

CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams

Optional parameters.

CassandraResourcesGetCassandraTableOptionalParams

Optional parameters.

CassandraResourcesGetCassandraTableThroughputOptionalParams

Optional parameters.

CassandraResourcesGetCassandraViewOptionalParams

Optional parameters.

CassandraResourcesGetCassandraViewThroughputOptionalParams

Optional parameters.

CassandraResourcesListCassandraKeyspacesOptionalParams

Optional parameters.

CassandraResourcesListCassandraTablesOptionalParams

Optional parameters.

CassandraResourcesListCassandraViewsOptionalParams

Optional parameters.

CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams

Optional parameters.

CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams

Optional parameters.

CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams

Optional parameters.

CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams

Optional parameters.

CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams

Optional parameters.

CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams

Optional parameters.

CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams

Optional parameters.

CassandraResourcesUpdateCassandraTableThroughputOptionalParams

Optional parameters.

CassandraResourcesUpdateCassandraViewThroughputOptionalParams

Optional parameters.

CassandraSchema

Cosmos DB Cassandra table schema

CassandraTableCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra table.

CassandraTableGetPropertiesOptions
CassandraTableGetPropertiesResource
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

CassandraViewCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra view.

CassandraViewGetPropertiesOptions
CassandraViewGetPropertiesResource
CassandraViewGetResults

An Azure Cosmos DB Cassandra view.

CassandraViewListResult

The List operation response, that contains the Cassandra views and their properties.

CassandraViewResource

Cosmos DB Cassandra view resource object

Certificate
ClientEncryptionIncludedPath

.

ClientEncryptionKeyCreateUpdateParameters

Parameters to create and update ClientEncryptionKey.

ClientEncryptionKeyGetPropertiesResource
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.

CloudError

An error response from the service.

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

CosmosCassandraDataTransferDataSourceSink

A CosmosDB Cassandra API data source/sink

CosmosDBManagementClientOptionalParams

Optional parameters.

CosmosSqlDataTransferDataSourceSink

A CosmosDB Cassandra API data source/sink

CreateJobRequest

Parameters to create Data Transfer Job

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.

DataTransferDataSourceSink

Base class for all DataTransfer source/sink

DataTransferJobFeedResults

The List operation response, that contains the Data Transfer jobs and their properties.

DataTransferJobGetResults

A Cosmos DB Data Transfer Job

DataTransferJobProperties

The properties of a DataTransfer Job

DataTransferJobs

Interface representing a DataTransferJobs.

DataTransferJobsCancelOptionalParams

Optional parameters.

DataTransferJobsCreateOptionalParams

Optional parameters.

DataTransferJobsGetOptionalParams

Optional parameters.

DataTransferJobsListByDatabaseAccountNextOptionalParams

Optional parameters.

DataTransferJobsListByDatabaseAccountOptionalParams

Optional parameters.

DataTransferJobsPauseOptionalParams

Optional parameters.

DataTransferJobsResumeOptionalParams

Optional parameters.

DataTransferRegionalServiceResource

Resource for a regional service location.

DataTransferServiceResource

Describes the service response property.

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.

DatabaseAccountsDeleteOptionalParams

Optional parameters.

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.

DatabaseAccountsOfflineRegionOptionalParams

Optional parameters.

DatabaseAccountsOnlineRegionOptionalParams

Optional parameters.

DatabaseAccountsRegenerateKeyOptionalParams

Optional parameters.

DatabaseAccountsUpdateOptionalParams

Optional parameters.

DatabaseListMetricDefinitionsOptionalParams

Optional parameters.

DatabaseListMetricsOptionalParams

Optional parameters.

DatabaseListUsagesOptionalParams

Optional parameters.

DatabaseRestoreResource

Specific Databases to restore.

DiagnosticLogSettings

Indicates what diagnostic log settings are to be enabled.

ErrorResponse

Error Response.

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.

GraphAPIComputeRegionalServiceResource

Resource for a regional service location.

GraphAPIComputeServiceResource

Describes the service response property for GraphAPICompute.

GraphAPIComputeServiceResourceProperties

Properties for GraphAPIComputeServiceResource.

GraphResource

Cosmos DB Graph resource object

GraphResourceCreateUpdateParameters

Parameters to create and update Cosmos DB Graph resource.

GraphResourceGetPropertiesOptions
GraphResourceGetPropertiesResource
GraphResourceGetResults

An Azure Cosmos DB Graph resource.

GraphResources

Interface representing a GraphResources.

GraphResourcesCreateUpdateGraphOptionalParams

Optional parameters.

GraphResourcesDeleteGraphResourceOptionalParams

Optional parameters.

GraphResourcesGetGraphOptionalParams

Optional parameters.

GraphResourcesListGraphsOptionalParams

Optional parameters.

GraphResourcesListResult

The List operation response, that contains the Graph resource and their properties.

GremlinDatabaseCreateUpdateParameters

Parameters to create and update Cosmos DB Gremlin database.

GremlinDatabaseGetPropertiesOptions
GremlinDatabaseGetPropertiesResource
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
GremlinGraphGetPropertiesResource
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.

GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams

Optional parameters.

GremlinResourcesCreateUpdateGremlinGraphOptionalParams

Optional parameters.

GremlinResourcesDeleteGremlinDatabaseOptionalParams

Optional parameters.

GremlinResourcesDeleteGremlinGraphOptionalParams

Optional parameters.

GremlinResourcesGetGremlinDatabaseOptionalParams

Optional parameters.

GremlinResourcesGetGremlinDatabaseThroughputOptionalParams

Optional parameters.

GremlinResourcesGetGremlinGraphOptionalParams

Optional parameters.

GremlinResourcesGetGremlinGraphThroughputOptionalParams

Optional parameters.

GremlinResourcesListGremlinDatabasesOptionalParams

Optional parameters.

GremlinResourcesListGremlinGraphsOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams

Optional parameters.

GremlinResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams

Optional parameters.

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.

ListBackups

List of restorable backups for a Cassandra cluster.

ListClusters

List of managed Cassandra clusters.

ListDataCenters

List of managed Cassandra data centers and their properties.

LocationGetResult

Cosmos DB location get result

LocationListResult

The List operation response, that contains Cosmos DB locations and their properties.

LocationProperties

Cosmos DB location metadata

Location_2

A region in which the Azure Cosmos DB database account is deployed.

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.

MaterializedViewsBuilderServiceResourceProperties

Properties for MaterializedViewsBuilderServiceResource.

MergeParameters

The properties of an Azure Cosmos DB merge operations

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
MongoDBCollectionGetPropertiesResource
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
MongoDBDatabaseGetPropertiesResource
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.

MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams

Optional parameters.

MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams

Optional parameters.

MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams

Optional parameters.

MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams

Optional parameters.

MongoDBResourcesDeleteMongoDBCollectionOptionalParams

Optional parameters.

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.

MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams

Optional parameters.

MongoDBResourcesListMongoDBCollectionsOptionalParams

Optional parameters.

MongoDBResourcesListMongoDBDatabasesOptionalParams

Optional parameters.

MongoDBResourcesListMongoRoleDefinitionsOptionalParams

Optional parameters.

MongoDBResourcesListMongoUserDefinitionsOptionalParams

Optional parameters.

MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams

Optional parameters.

MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams

Optional parameters.

MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams

Optional parameters.

MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams

Optional parameters.

MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams

Optional parameters.

MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams

Optional parameters.

MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams

Optional parameters.

MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams

Optional parameters.

MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams

Optional parameters.

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.

PhysicalPartitionId

PhysicalPartitionId object

PhysicalPartitionStorageInfo

The storage of a physical partition

PhysicalPartitionStorageInfoCollection

List of physical partitions and their properties returned by a merge operation.

PhysicalPartitionThroughputInfoProperties

The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoProperties object

PhysicalPartitionThroughputInfoResource

PhysicalPartitionThroughputInfo object

PhysicalPartitionThroughputInfoResult

An Azure Cosmos DB PhysicalPartitionThroughputInfoResult object.

PhysicalPartitionThroughputInfoResultPropertiesResource

properties of physical partition throughput info

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

RedistributeThroughputParameters

Cosmos DB redistribute throughput parameters object

RedistributeThroughputPropertiesResource

Resource to redistribute throughput for Azure Cosmos DB resource

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

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.

RetrieveThroughputParameters

Cosmos DB retrieve throughput parameters object

RetrieveThroughputPropertiesResource

Resource to retrieve throughput information for Cosmos DB resource

Role

The set of roles permitted through this Role Definition.

SeedNode
Service

Interface representing a Service.

ServiceCreateOptionalParams

Optional parameters.

ServiceDeleteOptionalParams

Optional parameters.

ServiceGetOptionalParams

Optional parameters.

ServiceListOptionalParams

Optional parameters.

ServiceResource

Properties for the database account.

ServiceResourceCreateUpdateParameters

Parameters for Create or Update Request for ServiceResource

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
SqlContainerGetPropertiesResource
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
SqlDatabaseGetPropertiesResource
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.

SqlDedicatedGatewayServiceResourceProperties

Properties for SqlDedicatedGatewayServiceResource.

SqlResources

Interface representing a SqlResources.

SqlResourcesCreateUpdateClientEncryptionKeyOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlContainerOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlDatabaseOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlRoleAssignmentOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlRoleDefinitionOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlStoredProcedureOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlTriggerOptionalParams

Optional parameters.

SqlResourcesCreateUpdateSqlUserDefinedFunctionOptionalParams

Optional parameters.

SqlResourcesDeleteSqlContainerOptionalParams

Optional parameters.

SqlResourcesDeleteSqlDatabaseOptionalParams

Optional parameters.

SqlResourcesDeleteSqlRoleAssignmentOptionalParams

Optional parameters.

SqlResourcesDeleteSqlRoleDefinitionOptionalParams

Optional parameters.

SqlResourcesDeleteSqlStoredProcedureOptionalParams

Optional parameters.

SqlResourcesDeleteSqlTriggerOptionalParams

Optional parameters.

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.

SqlResourcesListSqlContainerPartitionMergeOptionalParams

Optional parameters.

SqlResourcesListSqlContainersOptionalParams

Optional parameters.

SqlResourcesListSqlDatabasesOptionalParams

Optional parameters.

SqlResourcesListSqlRoleAssignmentsOptionalParams

Optional parameters.

SqlResourcesListSqlRoleDefinitionsOptionalParams

Optional parameters.

SqlResourcesListSqlStoredProceduresOptionalParams

Optional parameters.

SqlResourcesListSqlTriggersOptionalParams

Optional parameters.

SqlResourcesListSqlUserDefinedFunctionsOptionalParams

Optional parameters.

SqlResourcesMigrateSqlContainerToAutoscaleOptionalParams

Optional parameters.

SqlResourcesMigrateSqlContainerToManualThroughputOptionalParams

Optional parameters.

SqlResourcesMigrateSqlDatabaseToAutoscaleOptionalParams

Optional parameters.

SqlResourcesMigrateSqlDatabaseToManualThroughputOptionalParams

Optional parameters.

SqlResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

SqlResourcesSqlContainerRedistributeThroughputOptionalParams

Optional parameters.

SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams

Optional parameters.

SqlResourcesSqlDatabaseRedistributeThroughputOptionalParams

Optional parameters.

SqlResourcesSqlDatabaseRetrieveThroughputDistributionOptionalParams

Optional parameters.

SqlResourcesUpdateSqlContainerThroughputOptionalParams

Optional parameters.

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
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
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
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
TableGetPropertiesResource
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.

TableResourcesCreateUpdateTableOptionalParams

Optional parameters.

TableResourcesDeleteTableOptionalParams

Optional parameters.

TableResourcesGetTableOptionalParams

Optional parameters.

TableResourcesGetTableThroughputOptionalParams

Optional parameters.

TableResourcesListTablesOptionalParams

Optional parameters.

TableResourcesMigrateTableToAutoscaleOptionalParams

Optional parameters.

TableResourcesMigrateTableToManualThroughputOptionalParams

Optional parameters.

TableResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

TableResourcesUpdateTableThroughputOptionalParams

Optional parameters.

ThroughputPolicyResource

Cosmos DB resource throughput policy

ThroughputSettingsGetPropertiesResource
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.

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.

VirtualNetworkRule

Virtual Network ACL Rule object

Type Aliases

AnalyticalStorageSchemaType

Defines values for AnalyticalStorageSchemaType.
KnownAnalyticalStorageSchemaType can be used interchangeably with AnalyticalStorageSchemaType, this enum contains the known values that the service supports.

Known values supported by the service

WellDefined
FullFidelity

ApiType

Defines values for ApiType.
KnownApiType can be used interchangeably with ApiType, this enum contains the known values that the service supports.

Known values supported by the service

MongoDB
Gremlin
Cassandra
Table
Sql
GremlinV2

AuthenticationMethod

Defines values for AuthenticationMethod.
KnownAuthenticationMethod can be used interchangeably with AuthenticationMethod, this enum contains the known values that the service supports.

Known values supported by the service

None
Cassandra
Ldap

BackupPolicyMigrationStatus

Defines values for BackupPolicyMigrationStatus.
KnownBackupPolicyMigrationStatus can be used interchangeably with BackupPolicyMigrationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
InProgress
Completed
Failed

BackupPolicyType

Defines values for BackupPolicyType.
KnownBackupPolicyType can be used interchangeably with BackupPolicyType, this enum contains the known values that the service supports.

Known values supported by the service

Periodic
Continuous

BackupPolicyUnion
BackupStorageRedundancy

Defines values for BackupStorageRedundancy.
KnownBackupStorageRedundancy can be used interchangeably with BackupStorageRedundancy, this enum contains the known values that the service supports.

Known values supported by the service

Geo
Local
Zone

CassandraClustersCreateUpdateResponse

Contains response data for the createUpdate operation.

CassandraClustersGetBackupResponse

Contains response data for the getBackup operation.

CassandraClustersGetResponse

Contains response data for the get operation.

CassandraClustersInvokeCommandResponse

Contains response data for the invokeCommand operation.

CassandraClustersListBackupsResponse

Contains response data for the listBackups 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.

CassandraResourcesCreateUpdateCassandraViewResponse

Contains response data for the createUpdateCassandraView 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.

CassandraResourcesGetCassandraViewResponse

Contains response data for the getCassandraView operation.

CassandraResourcesGetCassandraViewThroughputResponse

Contains response data for the getCassandraViewThroughput operation.

CassandraResourcesListCassandraKeyspacesResponse

Contains response data for the listCassandraKeyspaces operation.

CassandraResourcesListCassandraTablesResponse

Contains response data for the listCassandraTables operation.

CassandraResourcesListCassandraViewsResponse

Contains response data for the listCassandraViews 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.

CassandraResourcesMigrateCassandraViewToAutoscaleResponse

Contains response data for the migrateCassandraViewToAutoscale operation.

CassandraResourcesMigrateCassandraViewToManualThroughputResponse

Contains response data for the migrateCassandraViewToManualThroughput operation.

CassandraResourcesUpdateCassandraKeyspaceThroughputResponse

Contains response data for the updateCassandraKeyspaceThroughput operation.

CassandraResourcesUpdateCassandraTableThroughputResponse

Contains response data for the updateCassandraTableThroughput operation.

CassandraResourcesUpdateCassandraViewThroughputResponse

Contains response data for the updateCassandraViewThroughput 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.
KnownCompositePathSortOrder can be used interchangeably with CompositePathSortOrder, this enum contains the known values that the service supports.

Known values supported by the service

ascending
descending

ConflictResolutionMode

Defines values for ConflictResolutionMode.
KnownConflictResolutionMode can be used interchangeably with ConflictResolutionMode, this enum contains the known values that the service supports.

Known values supported by the service

LastWriterWins
Custom

ConnectionState

Defines values for ConnectionState.
KnownConnectionState can be used interchangeably with ConnectionState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
OK
OperatorToDataCenterNetworkError
DatacenterToDatacenterNetworkError
InternalOperatorToDataCenterCertificateError
InternalError

ConnectorOffer

Defines values for ConnectorOffer.
KnownConnectorOffer can be used interchangeably with ConnectorOffer, this enum contains the known values that the service supports.

Known values supported by the service

Small

ContinuousTier

Defines values for ContinuousTier.
KnownContinuousTier can be used interchangeably with ContinuousTier, this enum contains the known values that the service supports.

Known values supported by the service

Continuous7Days
Continuous30Days

CreateMode

Defines values for CreateMode.
KnownCreateMode can be used interchangeably with CreateMode, this enum contains the known values that the service supports.

Known values supported by the service

Default
Restore

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DataTransferComponent

Defines values for DataTransferComponent.
KnownDataTransferComponent can be used interchangeably with DataTransferComponent, this enum contains the known values that the service supports.

Known values supported by the service

CosmosDBCassandra
CosmosDBSql
AzureBlobStorage

DataTransferDataSourceSinkUnion
DataTransferJobsCancelResponse

Contains response data for the cancel operation.

DataTransferJobsCreateResponse

Contains response data for the create operation.

DataTransferJobsGetResponse

Contains response data for the get operation.

DataTransferJobsListByDatabaseAccountNextResponse

Contains response data for the listByDatabaseAccountNext operation.

DataTransferJobsListByDatabaseAccountResponse

Contains response data for the listByDatabaseAccount operation.

DataTransferJobsPauseResponse

Contains response data for the pause operation.

DataTransferJobsResumeResponse

Contains response data for the resume operation.

DataType

Defines values for DataType.
KnownDataType can be used interchangeably with DataType, this enum contains the known values that the service supports.

Known values supported by the service

String
Number
Point
Polygon
LineString
MultiPolygon

DatabaseAccountKind

Defines values for DatabaseAccountKind.
KnownDatabaseAccountKind can be used interchangeably with DatabaseAccountKind, this enum contains the known values that the service supports.

Known values supported by the service

GlobalDocumentDB
MongoDB
Parse

DatabaseAccountRegionListMetricsResponse

Contains response data for the listMetrics operation.

DatabaseAccountsCheckNameExistsResponse

Contains response data for the checkNameExists operation.

DatabaseAccountsCreateOrUpdateResponse

Contains response data for the createOrUpdate 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.

DefaultConsistencyLevel

Defines values for DefaultConsistencyLevel.

EnableFullTextQuery

Defines values for EnableFullTextQuery.

GraphResourcesCreateUpdateGraphResponse

Contains response data for the createUpdateGraph operation.

GraphResourcesGetGraphResponse

Contains response data for the getGraph operation.

GraphResourcesListGraphsResponse

Contains response data for the listGraphs operation.

GremlinResourcesCreateUpdateGremlinDatabaseResponse

Contains response data for the createUpdateGremlinDatabase operation.

GremlinResourcesCreateUpdateGremlinGraphResponse

Contains response data for the createUpdateGremlinGraph 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.
KnownIndexKind can be used interchangeably with IndexKind, this enum contains the known values that the service supports.

Known values supported by the service

Hash
Range
Spatial

IndexingMode

Defines values for IndexingMode.
KnownIndexingMode can be used interchangeably with IndexingMode, this enum contains the known values that the service supports.

Known values supported by the service

consistent
lazy
none

KeyKind

Defines values for KeyKind.
KnownKeyKind can be used interchangeably with KeyKind, this enum contains the known values that the service supports.

Known values supported by the service

primary
secondary
primaryReadonly
secondaryReadonly

LocationsGetResponse

Contains response data for the get operation.

LocationsListResponse

Contains response data for the list operation.

ManagedCassandraProvisioningState

Defines values for ManagedCassandraProvisioningState.
KnownManagedCassandraProvisioningState can be used interchangeably with ManagedCassandraProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Updating
Deleting
Succeeded
Failed
Canceled

ManagedCassandraResourceIdentityType

Defines values for ManagedCassandraResourceIdentityType.
KnownManagedCassandraResourceIdentityType can be used interchangeably with ManagedCassandraResourceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned
None

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.

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.

MongoDBResourcesListMongoDBCollectionPartitionMergeResponse

Contains response data for the listMongoDBCollectionPartitionMerge 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.

MongoDBResourcesMongoDBContainerRedistributeThroughputResponse

Contains response data for the mongoDBContainerRedistributeThroughput operation.

MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse

Contains response data for the mongoDBContainerRetrieveThroughputDistribution operation.

MongoDBResourcesMongoDBDatabaseRedistributeThroughputResponse

Contains response data for the mongoDBDatabaseRedistributeThroughput operation.

MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionResponse

Contains response data for the mongoDBDatabaseRetrieveThroughputDistribution 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.
KnownNodeState can be used interchangeably with NodeState, this enum contains the known values that the service supports.

Known values supported by the service

Normal
Leaving
Joining
Moving
Stopped

NodeStatus

Defines values for NodeStatus.
KnownNodeStatus can be used interchangeably with NodeStatus, this enum contains the known values that the service supports.

Known values supported by the service

Up
Down

NotebookWorkspaceName

Defines values for NotebookWorkspaceName.
KnownNotebookWorkspaceName can be used interchangeably with NotebookWorkspaceName, this enum contains the known values that the service supports.

Known values supported by the service

default

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.
KnownOperationType can be used interchangeably with OperationType, this enum contains the known values that the service supports.

Known values supported by the service

Create
Replace
Delete
Recreate
SystemOperation

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.
KnownPartitionKind can be used interchangeably with PartitionKind, this enum contains the known values that the service supports.

Known values supported by the service

Hash
Range
MultiHash

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.
KnownPrimaryAggregationType can be used interchangeably with PrimaryAggregationType, this enum contains the known values that the service supports.

Known values supported by the service

None
Average
Total
Minimum
Maximum
Last

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.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

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.
KnownRestoreMode can be used interchangeably with RestoreMode, this enum contains the known values that the service supports.

Known values supported by the service

PointInTime

RoleDefinitionType

Defines values for RoleDefinitionType.

ServerVersion

Defines values for ServerVersion.
KnownServerVersion can be used interchangeably with ServerVersion, this enum contains the known values that the service supports.

Known values supported by the service

3.2
3.6
4.0
4.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.

ServiceResourcePropertiesUnion
ServiceSize

Defines values for ServiceSize.
KnownServiceSize can be used interchangeably with ServiceSize, this enum contains the known values that the service supports.

Known values supported by the service

Cosmos.D4s
Cosmos.D8s
Cosmos.D16s

ServiceStatus

Defines values for ServiceStatus.
KnownServiceStatus can be used interchangeably with ServiceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Running
Updating
Deleting
Error
Stopped

ServiceType

Defines values for ServiceType.
KnownServiceType can be used interchangeably with ServiceType, this enum contains the known values that the service supports.

Known values supported by the service

SqlDedicatedGateway
DataTransfer
GraphAPICompute
MaterializedViewsBuilder

SpatialType

Defines values for SpatialType.
KnownSpatialType can be used interchangeably with SpatialType, this enum contains the known values that the service supports.

Known values supported by the service

Point
LineString
Polygon
MultiPolygon

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.

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.

SqlResourcesListSqlContainerPartitionMergeResponse

Contains response data for the listSqlContainerPartitionMerge 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.

SqlResourcesSqlContainerRedistributeThroughputResponse

Contains response data for the sqlContainerRedistributeThroughput operation.

SqlResourcesSqlContainerRetrieveThroughputDistributionResponse

Contains response data for the sqlContainerRetrieveThroughputDistribution operation.

SqlResourcesSqlDatabaseRedistributeThroughputResponse

Contains response data for the sqlDatabaseRedistributeThroughput operation.

SqlResourcesSqlDatabaseRetrieveThroughputDistributionResponse

Contains response data for the sqlDatabaseRetrieveThroughputDistribution operation.

SqlResourcesUpdateSqlContainerThroughputResponse

Contains response data for the updateSqlContainerThroughput operation.

SqlResourcesUpdateSqlDatabaseThroughputResponse

Contains response data for the updateSqlDatabaseThroughput operation.

TableResourcesCreateUpdateTableResponse

Contains response data for the createUpdateTable 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.

ThroughputPolicyType

Defines values for ThroughputPolicyType.
KnownThroughputPolicyType can be used interchangeably with ThroughputPolicyType, this enum contains the known values that the service supports.

Known values supported by the service

none
equal
custom

TriggerOperation

Defines values for TriggerOperation.
KnownTriggerOperation can be used interchangeably with TriggerOperation, this enum contains the known values that the service supports.

Known values supported by the service

All
Create
Update
Delete
Replace

TriggerType

Defines values for TriggerType.
KnownTriggerType can be used interchangeably with TriggerType, this enum contains the known values that the service supports.

Known values supported by the service

Pre
Post

UnitType

Defines values for UnitType.
KnownUnitType can be used interchangeably with UnitType, this enum contains the known values that the service supports.

Known values supported by the service

Count
Bytes
Seconds
Percent
CountPerSecond
BytesPerSecond
Milliseconds

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.

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.

KnownDataTransferComponent

Known values of DataTransferComponent that the service accepts.

KnownDataType

Known values of DataType that the service accepts.

KnownDatabaseAccountKind

Known values of DatabaseAccountKind 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.

KnownManagedCassandraProvisioningState

Known values of ManagedCassandraProvisioningState that the service accepts.

KnownManagedCassandraResourceIdentityType

Known values of ManagedCassandraResourceIdentityType 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.

KnownThroughputPolicyType

Known values of ThroughputPolicyType that the service accepts.

KnownTriggerOperation

Known values of TriggerOperation that the service accepts.

KnownTriggerType

Known values of TriggerType that the service accepts.

KnownUnitType

Known values of UnitType that the service accepts.

Functions

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