@azure/arm-cosmosdb package

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.

AccessRule

Access rule in a network security perimeter configuration profile

AccessRuleProperties

Properties of Access Rule

AccountKeyMetadata

The metadata related to an access key for a given database account.

AnalyticalStorageConfiguration

Analytical storage specific properties.

ApiProperties

model interface ApiProperties

AuthenticationMethodLdapProperties

Ldap authentication method properties. This feature is in preview.

AutoUpgradePolicyResource

Cosmos DB resource auto-upgrade policy

AutoscaleSettings

model interface AutoscaleSettings

AutoscaleSettingsResource

Cosmos DB provisioned throughput settings object

AzureBlobContainer

An Azure Blob container

AzureBlobDataTransferDataSourceSink

An Azure Blob Storage data source/sink

AzureBlobSourceSinkDetails

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.

BackupSchedule

model interface BackupSchedule

BaseCopyJobProperties

Base copy job properties

BaseCopyJobTask

The properties of a Copy Job Task

BaseCosmosDataTransferDataSourceSink

A base CosmosDB data source/sink

BlobToCassandraRUCopyJobProperties

Source Azure Blob Storage to Destination Cassandra copy job properties

BlobToCassandraRUCopyJobTask

model interface BlobToCassandraRUCopyJobTask

Capability

Cosmos DB capability object

Capacity

The object that represents all properties related to capacity enforcement on an account.

CapacityModeChangeTransitionState

The transition state information related capacity mode change with update request.

CassandraClusterPublicStatus

Properties of a managed Cassandra cluster public status.

CassandraClusterPublicStatusDataCentersItem

model interface CassandraClusterPublicStatusDataCentersItem

CassandraClustersCreateUpdateOptionalParams

Optional parameters.

CassandraClustersDeallocateOptionalParams

Optional parameters.

CassandraClustersDeleteOptionalParams

Optional parameters.

CassandraClustersGetBackupOptionalParams

Optional parameters.

CassandraClustersGetCommandAsyncOptionalParams

Optional parameters.

CassandraClustersGetOptionalParams

Optional parameters.

CassandraClustersInvokeCommandAsyncOptionalParams

Optional parameters.

CassandraClustersInvokeCommandOptionalParams

Optional parameters.

CassandraClustersListBackupsOptionalParams

Optional parameters.

CassandraClustersListByResourceGroupOptionalParams

Optional parameters.

CassandraClustersListBySubscriptionOptionalParams

Optional parameters.

CassandraClustersListCommandOptionalParams

Optional parameters.

CassandraClustersOperations

Interface representing a CassandraClusters operations.

CassandraClustersStartOptionalParams

Optional parameters.

CassandraClustersStatusOptionalParams

Optional parameters.

CassandraClustersUpdateOptionalParams

Optional parameters.

CassandraDataCentersCreateUpdateOptionalParams

Optional parameters.

CassandraDataCentersDeleteOptionalParams

Optional parameters.

CassandraDataCentersGetOptionalParams

Optional parameters.

CassandraDataCentersListOptionalParams

Optional parameters.

CassandraDataCentersOperations

Interface representing a CassandraDataCenters operations.

CassandraDataCentersUpdateOptionalParams

Optional parameters.

CassandraError

model interface CassandraError

CassandraKeyspaceCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra keyspace.

CassandraKeyspaceCreateUpdateProperties

Properties to create and update Azure Cosmos DB Cassandra keyspace.

CassandraKeyspaceGetProperties

The properties of an Azure Cosmos DB Cassandra keyspace

CassandraKeyspaceGetPropertiesOptions

model interface CassandraKeyspaceGetPropertiesOptions

CassandraKeyspaceGetPropertiesResource

model interface CassandraKeyspaceGetPropertiesResource

CassandraKeyspaceGetResults

An Azure Cosmos DB Cassandra keyspace.

CassandraKeyspaceResource

Cosmos DB Cassandra keyspace resource object

CassandraPartitionKey

Cosmos DB Cassandra table partition key

CassandraRUToBlobCopyJobProperties

Source Cassandra to Destination Azure Blob Storage copy job properties

CassandraRUToBlobCopyJobTask

model interface CassandraRUToBlobCopyJobTask

CassandraRUToCassandraRUCopyJobProperties

Source Cassandra to Destination Cassandra copy job properties

CassandraRUToCassandraRUCopyJobTask

model interface CassandraRUToCassandraRUCopyJobTask

CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams

Optional parameters.

CassandraResourcesCreateUpdateCassandraRoleAssignmentOptionalParams

Optional parameters.

CassandraResourcesCreateUpdateCassandraRoleDefinitionOptionalParams

Optional parameters.

CassandraResourcesCreateUpdateCassandraTableOptionalParams

Optional parameters.

CassandraResourcesCreateUpdateCassandraViewOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraKeyspaceOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraRoleAssignmentOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraRoleDefinitionOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraTableOptionalParams

Optional parameters.

CassandraResourcesDeleteCassandraViewOptionalParams

Optional parameters.

CassandraResourcesGetCassandraKeyspaceOptionalParams

Optional parameters.

CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams

Optional parameters.

CassandraResourcesGetCassandraRoleAssignmentOptionalParams

Optional parameters.

CassandraResourcesGetCassandraRoleDefinitionOptionalParams

Optional parameters.

CassandraResourcesGetCassandraTableOptionalParams

Optional parameters.

CassandraResourcesGetCassandraTableThroughputOptionalParams

Optional parameters.

CassandraResourcesGetCassandraViewOptionalParams

Optional parameters.

CassandraResourcesGetCassandraViewThroughputOptionalParams

Optional parameters.

CassandraResourcesListCassandraKeyspacesOptionalParams

Optional parameters.

CassandraResourcesListCassandraRoleAssignmentsOptionalParams

Optional parameters.

CassandraResourcesListCassandraRoleDefinitionsOptionalParams

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.

CassandraResourcesOperations

Interface representing a CassandraResources operations.

CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams

Optional parameters.

CassandraResourcesUpdateCassandraTableThroughputOptionalParams

Optional parameters.

CassandraResourcesUpdateCassandraViewThroughputOptionalParams

Optional parameters.

CassandraRoleAssignmentResource

Parameters to create and update an Azure Cosmos DB Cassandra Role Assignment.

CassandraRoleAssignmentResourceProperties

Azure Cosmos DB Cassandra Role Assignment resource object.

CassandraRoleDefinitionResource

Parameters to create and update an Azure Cosmos DB Cassandra Role Definition.

CassandraRoleDefinitionResourceProperties

Azure Cosmos DB Cassandra Role Definition resource object.

CassandraSchema

Cosmos DB Cassandra table schema

CassandraTableCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra table.

CassandraTableCreateUpdateProperties

Properties to create and update Azure Cosmos DB Cassandra table.

CassandraTableGetProperties

The properties of an Azure Cosmos DB Cassandra table

CassandraTableGetPropertiesOptions

model interface CassandraTableGetPropertiesOptions

CassandraTableGetPropertiesResource

model interface CassandraTableGetPropertiesResource

CassandraTableGetResults

An Azure Cosmos DB Cassandra table.

CassandraTableResource

Cosmos DB Cassandra table resource object

CassandraViewCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra view.

CassandraViewCreateUpdateProperties

Properties to create and update Azure Cosmos DB Cassandra view.

CassandraViewGetProperties

The properties of an Azure Cosmos DB Cassandra view

CassandraViewGetPropertiesOptions

model interface CassandraViewGetPropertiesOptions

CassandraViewGetPropertiesResource

model interface CassandraViewGetPropertiesResource

CassandraViewGetResults

An Azure Cosmos DB Cassandra view.

CassandraViewResource

Cosmos DB Cassandra view resource object

Certificate

model interface Certificate

ChaosFaultEnableDisableOptionalParams

Optional parameters.

ChaosFaultGetOptionalParams

Optional parameters.

ChaosFaultListOptionalParams

Optional parameters.

ChaosFaultOperations

Interface representing a ChaosFault operations.

ChaosFaultProperties

A request object to enable/disable the chaos fault.

ChaosFaultResource

A request object to enable/disable the chaos fault

ClientEncryptionIncludedPath

.

ClientEncryptionKeyCreateUpdateParameters

Parameters to create and update ClientEncryptionKey.

ClientEncryptionKeyCreateUpdateProperties

Properties to create and update ClientEncryptionKey.

ClientEncryptionKeyGetProperties

The properties of a ClientEncryptionKey resource

ClientEncryptionKeyGetPropertiesResource

model interface ClientEncryptionKeyGetPropertiesResource

ClientEncryptionKeyGetResults

Client Encryption Key.

ClientEncryptionKeyResource

Cosmos DB client encryption key resource object.

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.

CollectionListMetricDefinitionsOptionalParams

Optional parameters.

CollectionListMetricsOptionalParams

Optional parameters.

CollectionListUsagesOptionalParams

Optional parameters.

CollectionOperations

Interface representing a Collection operations.

CollectionPartitionListMetricsOptionalParams

Optional parameters.

CollectionPartitionListUsagesOptionalParams

Optional parameters.

CollectionPartitionOperations

Interface representing a CollectionPartition operations.

CollectionPartitionRegionListMetricsOptionalParams

Optional parameters.

CollectionPartitionRegionOperations

Interface representing a CollectionPartitionRegion operations.

CollectionRegionListMetricsOptionalParams

Optional parameters.

CollectionRegionOperations

Interface representing a CollectionRegion operations.

Column

Cosmos DB Cassandra table column

CommandAsyncPostBody

Specification of which command to run where

CommandOutput

Response of /command api

CommandPostBody

Specification of which command to run where

CommandPublicResource

resource representing a command

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

model interface Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems

model interface ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems

CompositePath

model interface CompositePath

ComputedProperty

The definition of a computed property

ConflictResolutionPolicy

The conflict resolution policy for the container.

ConnectionError

model interface 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

CopyJobGetResults

A Cosmos DB Copy Job

CopyJobProperties

The properties of a Copy Job

CopyJobsCancelOptionalParams

Optional parameters.

CopyJobsCompleteOptionalParams

Optional parameters.

CopyJobsCreateOptionalParams

Optional parameters.

CopyJobsGetOptionalParams

Optional parameters.

CopyJobsListByDatabaseAccountOptionalParams

Optional parameters.

CopyJobsOperations

Interface representing a CopyJobs operations.

CopyJobsPauseOptionalParams

Optional parameters.

CopyJobsResumeOptionalParams

Optional parameters.

CorsPolicy

The CORS policy for the Cosmos DB database account.

CosmosCassandraDataTransferDataSourceSink

A CosmosDB Cassandra API data source/sink

CosmosDBCassandraTable

A CosmosDB Cassandra table

CosmosDBErrorResult

Error Response.

CosmosDBManagementClientOptionalParams

Optional parameters for the client.

CosmosDBMongoCollection

A CosmosDB Mongo collection

CosmosDBMongoVCoreCollection

A CosmosDB Mongo vCore collection

CosmosDBNoSqlContainer

A CosmosDB NoSQL container

CosmosDBSourceSinkDetails

A CosmosDB data source/sink details

CosmosMongoDataTransferDataSourceSink

A CosmosDB Mongo API data source/sink

CosmosMongoVCoreDataTransferDataSourceSink

A CosmosDB Mongo vCore API data source/sink

CosmosSqlDataTransferDataSourceSink

A CosmosDB No Sql 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.

DataMaskingPolicy

Data masking policy for the container.

DataMaskingPolicyExcludedPathsItem

JSON path to exclude from masking.

DataMaskingPolicyIncludedPathsItem

JSON path to include in the masking policy.

DataTransferDataSourceSink

Base class for all DataTransfer source/sink

DataTransferJobGetResults

A Cosmos DB Data Transfer Job

DataTransferJobProperties

The properties of a DataTransfer Job

DataTransferJobsCancelOptionalParams

Optional parameters.

DataTransferJobsCompleteOptionalParams

Optional parameters.

DataTransferJobsCreateOptionalParams

Optional parameters.

DataTransferJobsGetOptionalParams

Optional parameters.

DataTransferJobsListByDatabaseAccountOptionalParams

Optional parameters.

DataTransferJobsOperations

Interface representing a DataTransferJobs operations.

DataTransferJobsPauseOptionalParams

Optional parameters.

DataTransferJobsResumeOptionalParams

Optional parameters.

DataTransferRegionalServiceResource

Resource for a regional service location.

DataTransferServiceResourceCreateUpdateProperties

Properties for Create or Update request for DataTransferServiceResource

DataTransferServiceResourceProperties

Properties for DataTransferServiceResource.

DatabaseAccountConnectionString

Connection string for the Cosmos DB account

DatabaseAccountCreateUpdateParameters

Parameters to create and update Cosmos DB database accounts.

DatabaseAccountCreateUpdateProperties

Properties to create and update Azure Cosmos DB database accounts.

DatabaseAccountGetProperties

Properties for the database account.

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.

DatabaseAccountRegionListMetricsOptionalParams

Optional parameters.

DatabaseAccountRegionOperations

Interface representing a DatabaseAccountRegion operations.

DatabaseAccountUpdateParameters

Parameters for patching Azure Cosmos DB database account properties.

DatabaseAccountUpdateProperties

Properties to update Azure Cosmos DB database accounts.

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.

DatabaseAccountsListUsagesOptionalParams

Optional parameters.

DatabaseAccountsOfflineRegionOptionalParams

Optional parameters.

DatabaseAccountsOnlineRegionOptionalParams

Optional parameters.

DatabaseAccountsOperations

Interface representing a DatabaseAccounts operations.

DatabaseAccountsRegenerateKeyOptionalParams

Optional parameters.

DatabaseAccountsUpdateOptionalParams

Optional parameters.

DatabaseListMetricDefinitionsOptionalParams

Optional parameters.

DatabaseListMetricsOptionalParams

Optional parameters.

DatabaseListUsagesOptionalParams

Optional parameters.

DatabaseOperations

Interface representing a Database operations.

DatabaseRestoreResource

Specific Databases to restore.

DiagnosticLogSettings

Indicates what diagnostic log settings are to be enabled.

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.

ExcludedPath

model interface ExcludedPath

FailoverPolicies

The list of new failover policies for the failover priority change.

FailoverPolicy

The failover policy for a given region of a database account.

FleetAnalyticsCreateOptionalParams

Optional parameters.

FleetAnalyticsDeleteOptionalParams

Optional parameters.

FleetAnalyticsGetOptionalParams

Optional parameters.

FleetAnalyticsListOptionalParams

Optional parameters.

FleetAnalyticsOperations

Interface representing a FleetAnalytics operations.

FleetAnalyticsProperties

model interface FleetAnalyticsProperties

FleetAnalyticsResource

An Azure Cosmos DB FleetAnalytics.

FleetCreateOptionalParams

Optional parameters.

FleetDeleteOptionalParams

Optional parameters.

FleetGetOptionalParams

Optional parameters.

FleetListByResourceGroupOptionalParams

Optional parameters.

FleetListOptionalParams

Optional parameters.

FleetOperations

Interface representing a Fleet operations.

FleetResource

An Azure Cosmos DB FleetResource.

FleetResourceProperties

Properties to update Azure Cosmos DB fleet resource.

FleetResourceUpdate

Represents a fleet resource for updates.

FleetUpdateOptionalParams

Optional parameters.

FleetspaceAccountCreateOptionalParams

Optional parameters.

FleetspaceAccountDeleteOptionalParams

Optional parameters.

FleetspaceAccountGetOptionalParams

Optional parameters.

FleetspaceAccountListOptionalParams

Optional parameters.

FleetspaceAccountOperations

Interface representing a FleetspaceAccount operations.

FleetspaceAccountProperties

An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account.

FleetspaceAccountPropertiesGlobalDatabaseAccountProperties

Configuration for fleetspace Account in the fleetspace.

FleetspaceAccountResource

An Azure Cosmos DB Fleetspace Account

FleetspaceCreateOptionalParams

Optional parameters.

FleetspaceDeleteOptionalParams

Optional parameters.

FleetspaceGetOptionalParams

Optional parameters.

FleetspaceListOptionalParams

Optional parameters.

FleetspaceOperations

Interface representing a Fleetspace operations.

FleetspaceProperties

Properties to update Azure Cosmos DB Fleetspace.

FleetspacePropertiesThroughputPoolConfiguration

Configuration for throughput pool in the fleetspace.

FleetspaceResource

An Azure Cosmos DB Fleetspace.

FleetspaceUpdate

Represents a fleetspace resource for updates.

FleetspaceUpdateOptionalParams

Optional parameters.

FullTextIndexPath

Represents the full text index path.

FullTextPath

Represents the full text path specification.

FullTextPolicy

Cosmos DB FullText Policy

GarnetClusterResource

Representation of a Garnet cache cluster.

GarnetClusterResourcePatch

Representation of a Garnet cache cluster for updates.

GarnetClusterResourcePatchProperties

Properties of a Garnet cache cluster for updates.

GarnetClusterResourceProperties

Properties of a Garnet cache cluster.

GarnetClusterResourcePropertiesEndPointsItem

Endpoint for clients to connect to the cluster.

GarnetClustersCreateUpdateOptionalParams

Optional parameters.

GarnetClustersDeleteOptionalParams

Optional parameters.

GarnetClustersGetOptionalParams

Optional parameters.

GarnetClustersListByResourceGroupOptionalParams

Optional parameters.

GarnetClustersListBySubscriptionOptionalParams

Optional parameters.

GarnetClustersOperations

Interface representing a GarnetClusters operations.

GarnetClustersUpdateOptionalParams

Optional parameters.

GraphAPIComputeRegionalServiceResource

Resource for a regional service location.

GraphAPIComputeServiceResourceCreateUpdateProperties

Properties for Create or Update request for GraphAPIComputeServiceResource

GraphAPIComputeServiceResourceProperties

Properties for GraphAPIComputeServiceResource.

GraphResource

Cosmos DB Graph resource object

GraphResourceCreateUpdateParameters

Parameters to create and update Cosmos DB Graph resource.

GraphResourceCreateUpdateProperties

Properties to create and update Azure Cosmos DB Graph resource.

GraphResourceGetProperties

The properties of an Azure Cosmos DB SQL database

GraphResourceGetPropertiesOptions

model interface GraphResourceGetPropertiesOptions

GraphResourceGetPropertiesResource

model interface GraphResourceGetPropertiesResource

GraphResourceGetResults

An Azure Cosmos DB Graph resource.

GraphResourcesCreateUpdateGraphOptionalParams

Optional parameters.

GraphResourcesDeleteGraphResourceOptionalParams

Optional parameters.

GraphResourcesGetGraphOptionalParams

Optional parameters.

GraphResourcesListGraphsOptionalParams

Optional parameters.

GraphResourcesOperations

Interface representing a GraphResources operations.

GremlinDatabaseCreateUpdateParameters

Parameters to create and update Cosmos DB Gremlin database.

GremlinDatabaseCreateUpdateProperties

Properties to create and update Azure Cosmos DB Gremlin database.

GremlinDatabaseGetProperties

The properties of an Azure Cosmos DB SQL database

GremlinDatabaseGetPropertiesOptions

model interface GremlinDatabaseGetPropertiesOptions

GremlinDatabaseGetPropertiesResource

model interface GremlinDatabaseGetPropertiesResource

GremlinDatabaseGetResults

An Azure Cosmos DB Gremlin database.

GremlinDatabaseResource

Cosmos DB Gremlin database resource object

GremlinDatabaseRestoreResource

Specific Gremlin Databases to restore.

GremlinGraphCreateUpdateParameters

Parameters to create and update Cosmos DB Gremlin graph.

GremlinGraphCreateUpdateProperties

Properties to create and update Azure Cosmos DB Gremlin graph.

GremlinGraphGetProperties

The properties of an Azure Cosmos DB Gremlin graph

GremlinGraphGetPropertiesOptions

model interface GremlinGraphGetPropertiesOptions

GremlinGraphGetPropertiesResource

model interface GremlinGraphGetPropertiesResource

GremlinGraphGetResults

An Azure Cosmos DB Gremlin graph.

GremlinGraphResource

Cosmos DB Gremlin graph resource object

GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams

Optional parameters.

GremlinResourcesCreateUpdateGremlinGraphOptionalParams

Optional parameters.

GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams

Optional parameters.

GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams

Optional parameters.

GremlinResourcesDeleteGremlinDatabaseOptionalParams

Optional parameters.

GremlinResourcesDeleteGremlinGraphOptionalParams

Optional parameters.

GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams

Optional parameters.

GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams

Optional parameters.

GremlinResourcesGetGremlinDatabaseOptionalParams

Optional parameters.

GremlinResourcesGetGremlinDatabaseThroughputOptionalParams

Optional parameters.

GremlinResourcesGetGremlinGraphOptionalParams

Optional parameters.

GremlinResourcesGetGremlinGraphThroughputOptionalParams

Optional parameters.

GremlinResourcesGetGremlinRoleAssignmentOptionalParams

Optional parameters.

GremlinResourcesGetGremlinRoleDefinitionOptionalParams

Optional parameters.

GremlinResourcesListGremlinDatabasesOptionalParams

Optional parameters.

GremlinResourcesListGremlinGraphsOptionalParams

Optional parameters.

GremlinResourcesListGremlinRoleAssignmentsOptionalParams

Optional parameters.

GremlinResourcesListGremlinRoleDefinitionsOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams

Optional parameters.

GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams

Optional parameters.

GremlinResourcesOperations

Interface representing a GremlinResources operations.

GremlinResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams

Optional parameters.

GremlinResourcesUpdateGremlinGraphThroughputOptionalParams

Optional parameters.

GremlinRoleAssignmentResource

Parameters to create and update an Azure Cosmos DB Gremlin Role Assignment.

GremlinRoleAssignmentResourceProperties

Azure Cosmos DB Gremlin Role Assignment resource object.

GremlinRoleDefinitionResource

Parameters to create and update an Azure Cosmos DB Gremlin Role Definition.

GremlinRoleDefinitionResourceProperties

Azure Cosmos DB Gremlin Role Definition resource object.

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.

Location

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

LocationGetResult

Cosmos DB location get result

LocationProperties

Cosmos DB location metadata

LocationsGetOptionalParams

Optional parameters.

LocationsListOptionalParams

Optional parameters.

LocationsOperations

Interface representing a Locations operations.

ManagedCassandraManagedServiceIdentity

Identity for the resource.

ManagedCassandraReaperStatus

model interface ManagedCassandraReaperStatus

ManagedServiceIdentity

Identity for the resource.

MaterializedViewDefinition

Materialized View definition for the container.

MaterializedViewDetails

MaterializedViewDetails, contains Id & _rid fields of materialized view.

MaterializedViewsBuilderRegionalServiceResource

Resource for a regional service location.

MaterializedViewsBuilderServiceResourceCreateUpdateProperties

Properties for Create or Update request for MaterializedViewsBuilderServiceResource

MaterializedViewsBuilderServiceResourceProperties

Properties for MaterializedViewsBuilderServiceResource.

MaterializedViewsProperties

Materialized Views Properties for the source container.

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.

MetricName

A metric name.

MetricValue

Represents metrics values.

MongoDBCollectionCreateUpdateParameters

Parameters to create and update Cosmos DB MongoDB collection.

MongoDBCollectionCreateUpdateProperties

Properties to create and update Azure Cosmos DB MongoDB collection.

MongoDBCollectionGetProperties

The properties of an Azure Cosmos DB MongoDB collection

MongoDBCollectionGetPropertiesOptions

model interface MongoDBCollectionGetPropertiesOptions

MongoDBCollectionGetPropertiesResource

model interface MongoDBCollectionGetPropertiesResource

MongoDBCollectionGetResults

An Azure Cosmos DB MongoDB collection.

MongoDBCollectionResource

Cosmos DB MongoDB collection resource object

MongoDBDatabaseCreateUpdateParameters

Parameters to create and update Cosmos DB MongoDB database.

MongoDBDatabaseCreateUpdateProperties

Properties to create and update Azure Cosmos DB MongoDB database.

MongoDBDatabaseGetProperties

The properties of an Azure Cosmos DB MongoDB database

MongoDBDatabaseGetPropertiesOptions

model interface MongoDBDatabaseGetPropertiesOptions

MongoDBDatabaseGetPropertiesResource

model interface MongoDBDatabaseGetPropertiesResource

MongoDBDatabaseGetResults

An Azure Cosmos DB MongoDB database.

MongoDBDatabaseResource

Cosmos DB MongoDB database resource object

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.

MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams

Optional parameters.

MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams

Optional parameters.

MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams

Optional parameters.

MongoDBResourcesOperations

Interface representing a MongoDBResources operations.

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

MongoMIResourcesCreateUpdateMongoMIRoleAssignmentOptionalParams

Optional parameters.

MongoMIResourcesCreateUpdateMongoMIRoleDefinitionOptionalParams

Optional parameters.

MongoMIResourcesDeleteMongoMIRoleAssignmentOptionalParams

Optional parameters.

MongoMIResourcesDeleteMongoMIRoleDefinitionOptionalParams

Optional parameters.

MongoMIResourcesGetMongoMIRoleAssignmentOptionalParams

Optional parameters.

MongoMIResourcesGetMongoMIRoleDefinitionOptionalParams

Optional parameters.

MongoMIResourcesListMongoMIRoleAssignmentsOptionalParams

Optional parameters.

MongoMIResourcesListMongoMIRoleDefinitionsOptionalParams

Optional parameters.

MongoMIResourcesOperations

Interface representing a MongoMIResources operations.

MongoMIRoleAssignmentResource

Parameters to create and update an Azure Cosmos DB MongoMI Role Assignment.

MongoMIRoleAssignmentResourceProperties

Azure Cosmos DB MongoMI Role Assignment resource object.

MongoMIRoleDefinitionResource

Parameters to create and update an Azure Cosmos DB MongoMI Role Definition.

MongoMIRoleDefinitionResourceProperties

Azure Cosmos DB MongoMI Role Definition resource object.

MongoRUToMongoRUCopyJobProperties

Source Mongo to Destination Mongo copy job properties

MongoRUToMongoRUCopyJobTask

model interface MongoRUToMongoRUCopyJobTask

MongoRUToMongoVCoreCopyJobProperties

Source Mongo to Destination Mongo vCore copy job properties

MongoRUToMongoVCoreCopyJobTask

model interface MongoRUToMongoVCoreCopyJobTask

MongoRoleDefinitionCreateUpdateParameters

Parameters to create and update an Azure Cosmos DB Mongo Role Definition.

MongoRoleDefinitionGetResults

An Azure Cosmos DB Mongo Role Definition.

MongoRoleDefinitionResource

Azure Cosmos DB Mongo Role Definition resource object.

MongoUserDefinitionCreateUpdateParameters

Parameters to create and update an Azure Cosmos DB Mongo User Definition.

MongoUserDefinitionGetResults

An Azure Cosmos DB User Definition

MongoUserDefinitionResource

Azure Cosmos DB Mongo User Definition resource object.

MongoVCoreSourceSinkDetails

A CosmosDB Mongo vCore data source/sink details

NetworkSecurityPerimeter

Information about a network security perimeter (NSP)

NetworkSecurityPerimeterConfiguration

Network security perimeter (NSP) configuration resource

NetworkSecurityPerimeterConfigurationProperties

Network security configuration properties.

NetworkSecurityPerimeterConfigurationsGetOptionalParams

Optional parameters.

NetworkSecurityPerimeterConfigurationsListOptionalParams

Optional parameters.

NetworkSecurityPerimeterConfigurationsOperations

Interface representing a NetworkSecurityPerimeterConfigurations operations.

NetworkSecurityPerimeterConfigurationsReconcileOptionalParams

Optional parameters.

NetworkSecurityProfile

Network security perimeter configuration profile

NoSqlRUToNoSqlRUCopyJobProperties

Source SQL to Destination SQL copy job properties

NoSqlRUToNoSqlRUCopyJobTask

model interface NoSqlRUToNoSqlRUCopyJobTask

NotebookWorkspace

A notebook workspace resource

NotebookWorkspaceConnectionInfoResult

The connection info for the given notebook workspace

NotebookWorkspaceCreateUpdateParameters

Parameters to create a notebook workspace resource

NotebookWorkspaceProperties

Properties of a notebook workspace resource.

NotebookWorkspacesCreateOrUpdateOptionalParams

Optional parameters.

NotebookWorkspacesDeleteOptionalParams

Optional parameters.

NotebookWorkspacesGetOptionalParams

Optional parameters.

NotebookWorkspacesListByDatabaseAccountOptionalParams

Optional parameters.

NotebookWorkspacesListConnectionInfoOptionalParams

Optional parameters.

NotebookWorkspacesOperations

Interface representing a NotebookWorkspaces operations.

NotebookWorkspacesRegenerateAuthTokenOptionalParams

Optional parameters.

NotebookWorkspacesStartOptionalParams

Optional parameters.

Operation

REST API operation

OperationDisplay

The object that represents the operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

OptionsResource

Cosmos DB options resource object

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PartitionKeyRangeIdListMetricsOptionalParams

Optional parameters.

PartitionKeyRangeIdOperations

Interface representing a PartitionKeyRangeId operations.

PartitionKeyRangeIdRegionListMetricsOptionalParams

Optional parameters.

PartitionKeyRangeIdRegionOperations

Interface representing a PartitionKeyRangeIdRegion operations.

PartitionMetric

The metric values for a single partition.

PartitionUsage

The partition level usage data for a usage request.

PercentileListMetricsOptionalParams

Optional parameters.

PercentileMetric

Percentile Metric data

PercentileMetricValue

Represents percentile metrics values.

PercentileOperations

Interface representing a Percentile operations.

PercentileSourceTargetListMetricsOptionalParams

Optional parameters.

PercentileSourceTargetOperations

Interface representing a PercentileSourceTarget operations.

PercentileTargetListMetricsOptionalParams

Optional parameters.

PercentileTargetOperations

Interface representing a PercentileTarget operations.

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.

PhysicalPartitionThroughputInfoResultProperties

The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object

PhysicalPartitionThroughputInfoResultPropertiesResource

properties of physical partition throughput info

PrivateEndpointConnection

A private endpoint connection

PrivateEndpointConnectionProperties

Properties of a private endpoint connection.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByDatabaseAccountOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateEndpointProperty

Private endpoint which the connection belongs to.

PrivateLinkResource

A private link resource

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByDatabaseAccountOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

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.

ProvisioningIssue

Describes a provisioning issue for a network security perimeter configuration

ProvisioningIssueProperties

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules

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

RedistributeThroughputProperties

Properties to redistribute throughput for Azure Cosmos DB resource.

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

ResourceAssociation

Information about resource association

ResourceRestoreParameters

Parameters to indicate the information about the restore.

RestorableDatabaseAccountGetResult

A Azure Cosmos DB restorable database account.

RestorableDatabaseAccountProperties

The properties of a restorable database account.

RestorableDatabaseAccountsGetByLocationOptionalParams

Optional parameters.

RestorableDatabaseAccountsListByLocationOptionalParams

Optional parameters.

RestorableDatabaseAccountsListOptionalParams

Optional parameters.

RestorableDatabaseAccountsOperations

Interface representing a RestorableDatabaseAccounts operations.

RestorableGremlinDatabaseGetResult

An Azure Cosmos DB Gremlin database event

RestorableGremlinDatabaseProperties

The properties of an Azure Cosmos DB Gremlin database event

RestorableGremlinDatabasePropertiesResource

The resource of an Azure Cosmos DB Gremlin database event

RestorableGremlinDatabasesListOptionalParams

Optional parameters.

RestorableGremlinDatabasesOperations

Interface representing a RestorableGremlinDatabases operations.

RestorableGremlinGraphGetResult

An Azure Cosmos DB Gremlin graph event

RestorableGremlinGraphProperties

The properties of an Azure Cosmos DB Gremlin graph event

RestorableGremlinGraphPropertiesResource

The resource of an Azure Cosmos DB Gremlin graph event

RestorableGremlinGraphsListOptionalParams

Optional parameters.

RestorableGremlinGraphsOperations

Interface representing a RestorableGremlinGraphs operations.

RestorableGremlinResourcesGetResult

Specific Databases to restore.

RestorableGremlinResourcesListOptionalParams

Optional parameters.

RestorableGremlinResourcesOperations

Interface representing a RestorableGremlinResources operations.

RestorableLocationResource

Properties of the regional restorable account.

RestorableMongodbCollectionGetResult

An Azure Cosmos DB MongoDB collection event

RestorableMongodbCollectionProperties

The properties of an Azure Cosmos DB MongoDB collection event

RestorableMongodbCollectionPropertiesResource

The resource of an Azure Cosmos DB MongoDB collection event

RestorableMongodbCollectionsListOptionalParams

Optional parameters.

RestorableMongodbCollectionsOperations

Interface representing a RestorableMongodbCollections operations.

RestorableMongodbDatabaseGetResult

An Azure Cosmos DB MongoDB database event

RestorableMongodbDatabaseProperties

The properties of an Azure Cosmos DB MongoDB database event

RestorableMongodbDatabasePropertiesResource

The resource of an Azure Cosmos DB MongoDB database event

RestorableMongodbDatabasesListOptionalParams

Optional parameters.

RestorableMongodbDatabasesOperations

Interface representing a RestorableMongodbDatabases operations.

RestorableMongodbResourcesGetResult

Specific Databases to restore.

RestorableMongodbResourcesListOptionalParams

Optional parameters.

RestorableMongodbResourcesOperations

Interface representing a RestorableMongodbResources operations.

RestorableSqlContainerGetResult

An Azure Cosmos DB SQL container event

RestorableSqlContainerProperties

The properties of 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

RestorableSqlContainersListOptionalParams

Optional parameters.

RestorableSqlContainersOperations

Interface representing a RestorableSqlContainers operations.

RestorableSqlDatabaseGetResult

An Azure Cosmos DB SQL database event

RestorableSqlDatabaseProperties

The properties of 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

RestorableSqlDatabasesListOptionalParams

Optional parameters.

RestorableSqlDatabasesOperations

Interface representing a RestorableSqlDatabases operations.

RestorableSqlResourcesGetResult

Specific Databases to restore.

RestorableSqlResourcesListOptionalParams

Optional parameters.

RestorableSqlResourcesOperations

Interface representing a RestorableSqlResources operations.

RestorableTableGetResult

An Azure Cosmos DB Table event

RestorableTableProperties

The properties of an Azure Cosmos DB Table event

RestorableTablePropertiesResource

The resource of an Azure Cosmos DB Table event

RestorableTableResourcesGetResult

Specific Databases to restore.

RestorableTableResourcesListOptionalParams

Optional parameters.

RestorableTableResourcesOperations

Interface representing a RestorableTableResources operations.

RestorableTablesListOptionalParams

Optional parameters.

RestorableTablesOperations

Interface representing a RestorableTables operations.

RestoreParameters

Parameters to indicate the information about the restore.

RestoreParametersBase

Parameters to indicate the information about the restore.

RestorePollerOptions
RetrieveThroughputParameters

Cosmos DB retrieve throughput parameters object

RetrieveThroughputProperties

Properties to retrieve throughput for Azure Cosmos DB resource.

RetrieveThroughputPropertiesResource

Resource to retrieve throughput information for Cosmos DB resource

Role

The set of roles permitted through this Role Definition.

SeedNode

model interface SeedNode

ServiceCreateOptionalParams

Optional parameters.

ServiceDeleteOptionalParams

Optional parameters.

ServiceGetOptionalParams

Optional parameters.

ServiceListOptionalParams

Optional parameters.

ServiceOperations

Interface representing a Service operations.

ServiceResource

Properties for the database account.

ServiceResourceCreateUpdateParameters

Parameters for Create or Update request for ServiceResource

ServiceResourceCreateUpdateProperties

Properties in ServiceResourceCreateUpdateParameters.

ServiceResourceProperties

Services response resource.

SimplePollerLike

A simple poller that can be used to poll a long running operation.

SpatialSpec

model interface SpatialSpec

SqlContainerCreateUpdateParameters

Parameters to create and update Cosmos DB container.

SqlContainerCreateUpdateProperties

Properties to create and update Azure Cosmos DB container.

SqlContainerGetProperties

The properties of an Azure Cosmos DB container

SqlContainerGetPropertiesOptions

model interface SqlContainerGetPropertiesOptions

SqlContainerGetPropertiesResource

model interface SqlContainerGetPropertiesResource

SqlContainerGetResults

An Azure Cosmos DB container.

SqlContainerResource

Cosmos DB SQL container resource object

SqlDatabaseCreateUpdateParameters

Parameters to create and update Cosmos DB SQL database.

SqlDatabaseCreateUpdateProperties

Properties to create and update Azure Cosmos DB SQL database.

SqlDatabaseGetProperties

The properties of an Azure Cosmos DB SQL database

SqlDatabaseGetPropertiesOptions

model interface SqlDatabaseGetPropertiesOptions

SqlDatabaseGetPropertiesResource

model interface SqlDatabaseGetPropertiesResource

SqlDatabaseGetResults

An Azure Cosmos DB SQL database.

SqlDatabaseResource

Cosmos DB SQL database resource object

SqlDedicatedGatewayRegionalServiceResource

Resource for a regional service location.

SqlDedicatedGatewayServiceResourceCreateUpdateProperties

Properties for Create or Update request for SqlDedicatedGatewayServiceResource

SqlDedicatedGatewayServiceResourceProperties

Properties for SqlDedicatedGatewayServiceResource.

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.

SqlResourcesOperations

Interface representing a SqlResources operations.

SqlResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

SqlResourcesSqlContainerRedistributeThroughputOptionalParams

Optional parameters.

SqlResourcesSqlContainerRetrieveThroughputDistributionOptionalParams

Optional parameters.

SqlResourcesSqlDatabasePartitionMergeOptionalParams

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

SqlRoleAssignmentResource

Azure Cosmos DB SQL Role Assignment resource object.

SqlRoleDefinitionCreateUpdateParameters

Parameters to create and update an Azure Cosmos DB SQL Role Definition.

SqlRoleDefinitionGetResults

An Azure Cosmos DB SQL Role Definition.

SqlRoleDefinitionResource

Azure Cosmos DB SQL Role Definition resource object.

SqlStoredProcedureCreateUpdateParameters

Parameters to create and update Cosmos DB storedProcedure.

SqlStoredProcedureCreateUpdateProperties

Properties to create and update Azure Cosmos DB storedProcedure.

SqlStoredProcedureGetProperties

The properties of an Azure Cosmos DB StoredProcedure

SqlStoredProcedureGetPropertiesResource

model interface SqlStoredProcedureGetPropertiesResource

SqlStoredProcedureGetResults

An Azure Cosmos DB storedProcedure.

SqlStoredProcedureResource

Cosmos DB SQL storedProcedure resource object

SqlTriggerCreateUpdateParameters

Parameters to create and update Cosmos DB trigger.

SqlTriggerCreateUpdateProperties

Properties to create and update Azure Cosmos DB trigger.

SqlTriggerGetProperties

The properties of an Azure Cosmos DB trigger

SqlTriggerGetPropertiesResource

model interface SqlTriggerGetPropertiesResource

SqlTriggerGetResults

An Azure Cosmos DB trigger.

SqlTriggerResource

Cosmos DB SQL trigger resource object

SqlUserDefinedFunctionCreateUpdateParameters

Parameters to create and update Cosmos DB userDefinedFunction.

SqlUserDefinedFunctionCreateUpdateProperties

Properties to create and update Azure Cosmos DB userDefinedFunction.

SqlUserDefinedFunctionGetProperties

The properties of an Azure Cosmos DB userDefinedFunction

SqlUserDefinedFunctionGetPropertiesResource

model interface SqlUserDefinedFunctionGetPropertiesResource

SqlUserDefinedFunctionGetResults

An Azure Cosmos DB userDefinedFunction.

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.

TableCreateUpdateProperties

Properties to create and update Azure Cosmos DB Table.

TableGetProperties

The properties of an Azure Cosmos Table

TableGetPropertiesOptions

model interface TableGetPropertiesOptions

TableGetPropertiesResource

model interface TableGetPropertiesResource

TableGetResults

An Azure Cosmos DB Table.

TableResource

Cosmos DB table resource object

TableResourcesCreateUpdateTableOptionalParams

Optional parameters.

TableResourcesCreateUpdateTableRoleAssignmentOptionalParams

Optional parameters.

TableResourcesCreateUpdateTableRoleDefinitionOptionalParams

Optional parameters.

TableResourcesDeleteTableOptionalParams

Optional parameters.

TableResourcesDeleteTableRoleAssignmentOptionalParams

Optional parameters.

TableResourcesDeleteTableRoleDefinitionOptionalParams

Optional parameters.

TableResourcesGetTableOptionalParams

Optional parameters.

TableResourcesGetTableRoleAssignmentOptionalParams

Optional parameters.

TableResourcesGetTableRoleDefinitionOptionalParams

Optional parameters.

TableResourcesGetTableThroughputOptionalParams

Optional parameters.

TableResourcesListTableRoleAssignmentsOptionalParams

Optional parameters.

TableResourcesListTableRoleDefinitionsOptionalParams

Optional parameters.

TableResourcesListTablesOptionalParams

Optional parameters.

TableResourcesMigrateTableToAutoscaleOptionalParams

Optional parameters.

TableResourcesMigrateTableToManualThroughputOptionalParams

Optional parameters.

TableResourcesOperations

Interface representing a TableResources operations.

TableResourcesRetrieveContinuousBackupInformationOptionalParams

Optional parameters.

TableResourcesUpdateTableThroughputOptionalParams

Optional parameters.

TableRoleAssignmentResource

Parameters to create and update an Azure Cosmos DB Table Role Assignment.

TableRoleAssignmentResourceProperties

Azure Cosmos DB Table Role Assignment resource object.

TableRoleDefinitionResource

Parameters to create and update an Azure Cosmos DB Table Role Definition.

TableRoleDefinitionResourceProperties

Azure Cosmos DB Table Role Definition resource object.

ThroughputBucketResource

Cosmos DB throughput bucket object

ThroughputPolicyResource

Cosmos DB resource throughput policy

ThroughputPoolAccountCreateOptionalParams

Optional parameters.

ThroughputPoolAccountDeleteOptionalParams

Optional parameters.

ThroughputPoolAccountGetOptionalParams

Optional parameters.

ThroughputPoolAccountOperations

Interface representing a ThroughputPoolAccount operations.

ThroughputPoolAccountProperties

An Azure Cosmos DB Global Database Account which is part of a Throughputpool.

ThroughputPoolAccountResource

An Azure Cosmos DB Throughputpool Account

ThroughputPoolAccountsListOptionalParams

Optional parameters.

ThroughputPoolAccountsOperations

Interface representing a ThroughputPoolAccounts operations.

ThroughputPoolCreateOrUpdateOptionalParams

Optional parameters.

ThroughputPoolDeleteOptionalParams

Optional parameters.

ThroughputPoolGetOptionalParams

Optional parameters.

ThroughputPoolOperations

Interface representing a ThroughputPool operations.

ThroughputPoolProperties

Properties to update Azure Cosmos DB throughput pool.

ThroughputPoolResource

An Azure Cosmos DB Throughputpool.

ThroughputPoolUpdate

Represents a throughput pool resource for updates.

ThroughputPoolUpdateOptionalParams

Optional parameters.

ThroughputPoolsListByResourceGroupOptionalParams

Optional parameters.

ThroughputPoolsListOptionalParams

Optional parameters.

ThroughputPoolsOperations

Interface representing a ThroughputPools operations.

ThroughputSettingsGetProperties

The properties of an Azure Cosmos DB resource throughput

ThroughputSettingsGetPropertiesResource

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

ThroughputSettingsUpdateProperties

Properties to update Azure 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.

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

model interface VectorIndex

VirtualNetworkRule

Virtual Network ACL Rule object

Type Aliases

AccessRuleDirection

Direction of Access Rule
KnownAccessRuleDirection can be used interchangeably with AccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Applies to inbound network traffic to the secured resources.
Outbound: Applies to outbound network traffic from the secured resources

AllocationState

Allocation state of the cluster and data center resources.
KnownAllocationState can be used interchangeably with AllocationState, this enum contains the known values that the service supports.

Known values supported by the service

Active: Active implies the virtual machines of the cluster are allocated.
Deallocated: Deallocated implies virtual machines and resources are deallocated.

AnalyticalStorageSchemaType

Describes the types of schema for analytical storage.
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

Enum to indicate the API type of the restorable database account.
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

Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
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

AutoReplicate

The form of AutoReplicate that is being used by this cluster.
KnownAutoReplicate can be used interchangeably with AutoReplicate, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemKeyspaces
AllKeyspaces

AzureConnectionType

How to connect to the azure services needed for running the cluster
KnownAzureConnectionType can be used interchangeably with AzureConnectionType, this enum contains the known values that the service supports.

Known values supported by the service

None
VPN

AzureSupportedClouds

The supported values for cloud setting as a string literal type

BackupPolicyMigrationStatus

Describes the status of migration between backup policy types.
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

Describes the mode of backups.
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

Alias for BackupPolicyUnion

BackupState

The current state of the backup.
KnownBackupState can be used interchangeably with BackupState, this enum contains the known values that the service supports.

Known values supported by the service

Initiated
InProgress
Succeeded
Failed

BackupStorageRedundancy

Enum to indicate type of backup storage redundancy.
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

BaseCopyJobPropertiesUnion

Alias for BaseCopyJobPropertiesUnion

BaseCosmosDataTransferDataSourceSinkUnion

Alias for BaseCosmosDataTransferDataSourceSinkUnion

CapacityMode

Indicates the capacity mode of the account.
KnownCapacityMode can be used interchangeably with CapacityMode, this enum contains the known values that the service supports.

Known values supported by the service

None
Provisioned
Serverless

CapacityModeTransitionStatus

The transition status of capacity mode.
KnownCapacityModeTransitionStatus can be used interchangeably with CapacityModeTransitionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
Initialized
InProgress
Completed
Failed

ClusterType

Type of the cluster. If set to Production, some operations might not be permitted on cluster.
KnownClusterType can be used interchangeably with ClusterType, this enum contains the known values that the service supports.

Known values supported by the service

Production
NonProduction

CommandStatus

Status of the command.
KnownCommandStatus can be used interchangeably with CommandStatus, this enum contains the known values that the service supports.

Known values supported by the service

Done
Running
Enqueue
Processing
Finished
Failed

CompositePathSortOrder

Sort order for composite paths.
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

Indicates the conflict resolution mode.
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

The kind of connection error that occurred.
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

The cassandra connector offer type for the Cosmos DB C* database account.
KnownConnectorOffer can be used interchangeably with ConnectorOffer, this enum contains the known values that the service supports.

Known values supported by the service

Small

ContinuablePage

An interface that describes a page of results.

ContinuousTier

Enum to indicate type of Continuous backup tier.
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

CopyJobMode

Mode of job execution
KnownCopyJobMode can be used interchangeably with CopyJobMode, this enum contains the known values that the service supports.

Known values supported by the service

Offline
Online

CopyJobStatus

Job Status
KnownCopyJobStatus can be used interchangeably with CopyJobStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Partitioning
Running
Paused
Completed
Faulted
Cancelled

CopyJobType

Copy Job Type
KnownCopyJobType can be used interchangeably with CopyJobType, this enum contains the known values that the service supports.

Known values supported by the service

CassandraRUToCassandraRU
CassandraRUToAzureBlobStorage
AzureBlobStorageToCassandraRU
MongoRUToMongoRU
MongoRUToMongoVCore
NoSqlRUToNoSqlRU

CreateMode

Enum to indicate the mode of account creation.
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

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DataTransferComponent

Type of DataTransferComponent

DataTransferDataSourceSinkUnion

Alias for DataTransferDataSourceSinkUnion

DataTransferJobMode

Mode of job execution
KnownDataTransferJobMode can be used interchangeably with DataTransferJobMode, this enum contains the known values that the service supports.

Known values supported by the service

Offline
Online

DataType

The datatype for which the indexing behavior is applied to.
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

Indicates the type of database account. This can only be set at database account creation.
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

DatabaseAccountsCheckNameExistsResponse
DedicatedGatewayType

DedicatedGatewayType for the service.
KnownDedicatedGatewayType can be used interchangeably with DedicatedGatewayType, this enum contains the known values that the service supports.

Known values supported by the service

IntegratedCache
DistributedQuery

DefaultConsistencyLevel

The default consistency level and configuration settings of the Cosmos DB account.

DefaultPriorityLevel

Enum to indicate default priorityLevel of requests
KnownDefaultPriorityLevel can be used interchangeably with DefaultPriorityLevel, this enum contains the known values that the service supports.

Known values supported by the service

High
Low

DistanceFunction

The distance function to use for distance calculation in between vectors.
KnownDistanceFunction can be used interchangeably with DistanceFunction, this enum contains the known values that the service supports.

Known values supported by the service

euclidean
cosine
dotproduct

EnableFullTextQuery

Describe the level of detail with which queries are to be logged.

FleetAnalyticsPropertiesStorageLocationType

The type of the fleet analytics resource.
KnownFleetAnalyticsPropertiesStorageLocationType can be used interchangeably with FleetAnalyticsPropertiesStorageLocationType, this enum contains the known values that the service supports.

Known values supported by the service

StorageAccount
FabricLakehouse

FleetspacePropertiesFleetspaceApiKind

The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
KnownFleetspacePropertiesFleetspaceApiKind can be used interchangeably with FleetspacePropertiesFleetspaceApiKind, this enum contains the known values that the service supports.

Known values supported by the service

NoSQL

FleetspacePropertiesServiceTier

Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
KnownFleetspacePropertiesServiceTier can be used interchangeably with FleetspacePropertiesServiceTier, this enum contains the known values that the service supports.

Known values supported by the service

GeneralPurpose
BusinessCritical

GarnetCacheProvisioningState

The status of the resource at the time the operation was called.
KnownGarnetCacheProvisioningState can be used interchangeably with GarnetCacheProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Failed: Failed
Canceled: Canceled

IndexKind

Indicates the type of index.
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

Indicates the indexing mode.
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

IssueType

Type of issue
KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown issue type
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration.
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules.
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP.

KeyKind

The access key to regenerate.
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

Kind

Kind of the connection string key
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

Primary
Secondary
PrimaryReadonly
SecondaryReadonly

ManagedCassandraProvisioningState

The status of the resource at the time the operation was called.
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

The type of the resource.
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

MinimalTlsVersion

Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.
KnownMinimalTlsVersion can be used interchangeably with MinimalTlsVersion, this enum contains the known values that the service supports.

Known values supported by the service

Tls
Tls11
Tls12

MongoRoleDefinitionType

Indicates whether the Role Definition was built-in or user created.

NetworkAclBypass

Indicates what services are allowed to bypass firewall checks.

NetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of a network security perimeter configuration that is being created or updated.
KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NodeState

The state of the node in Cassandra ring.
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

NotebookWorkspaceName

Type of NotebookWorkspaceName

OperationType

Enum to indicate the operation type of the event.
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

PartitionKind

Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
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

PrimaryAggregationType

The primary aggregation type of the metric.
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

PublicNetworkAccess

Whether requests from Public Network are allowed
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
SecuredByPerimeter

ResourceAssociationAccessMode

Access mode of the resource association
KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

RestoreMode

Describes the mode of the restore.
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

Indicates whether the Role Definition was built-in or user created.

ScheduledEventStrategy

How the nodes in the cluster react to scheduled events
KnownScheduledEventStrategy can be used interchangeably with ScheduledEventStrategy, this enum contains the known values that the service supports.

Known values supported by the service

Ignore
StopAny
StopByRack

ServerVersion

Describes the version of the MongoDB account.
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
5.0
6.0
7.0

ServiceResourceCreateUpdatePropertiesUnion

Alias for ServiceResourceCreateUpdatePropertiesUnion

ServiceResourcePropertiesUnion

Alias for ServiceResourcePropertiesUnion

ServiceSize

Instance type for the service.
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

Describes the status of a service.
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

ServiceType for the service.
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

Severity

Severity of the issue.
KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports.

Known values supported by the service

Warning
Error

SpatialType

Indicates the spatial type of index.
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

Status

Enum to indicate current buildout status of the region.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Uninitialized
Initializing
InternallyReady
Online
Deleting
Succeeded
Failed
Canceled
Updating
Creating

SupportedActions

Indicates whether what action to take for the Chaos Fault.

ThroughputPolicyType

ThroughputPolicy to apply for throughput redistribution
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

The operation the trigger is associated with
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

Type of the Trigger
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

Type

Type of the connection string
KnownType can be used interchangeably with Type, this enum contains the known values that the service supports.

Known values supported by the service

Sql
Table
MongoDB
Cassandra
CassandraConnectorMetadata
Gremlin
SqlDedicatedGateway
GremlinV2
Undefined

UnitType

The unit of the metric.
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

VectorDataType

Indicates the data type of vector.
KnownVectorDataType can be used interchangeably with VectorDataType, this enum contains the known values that the service supports.

Known values supported by the service

float32
uint8
int8
float16

VectorIndexType

The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
KnownVectorIndexType can be used interchangeably with VectorIndexType, this enum contains the known values that the service supports.

Known values supported by the service

flat
diskANN
quantizedFlat

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAccessRuleDirection

Direction of Access Rule

KnownAllocationState

Allocation state of the cluster and data center resources.

KnownAnalyticalStorageSchemaType

Describes the types of schema for analytical storage.

KnownApiType

Enum to indicate the API type of the restorable database account.

KnownAuthenticationMethod

Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.

KnownAutoReplicate

The form of AutoReplicate that is being used by this cluster.

KnownAzureConnectionType

How to connect to the azure services needed for running the cluster

KnownBackupPolicyMigrationStatus

Describes the status of migration between backup policy types.

KnownBackupPolicyType

Describes the mode of backups.

KnownBackupState

The current state of the backup.

KnownBackupStorageRedundancy

Enum to indicate type of backup storage redundancy.

KnownCapacityMode

Indicates the capacity mode of the account.

KnownCapacityModeTransitionStatus

The transition status of capacity mode.

KnownClusterType

Type of the cluster. If set to Production, some operations might not be permitted on cluster.

KnownCommandStatus

Status of the command.

KnownCompositePathSortOrder

Sort order for composite paths.

KnownConflictResolutionMode

Indicates the conflict resolution mode.

KnownConnectionState

The kind of connection error that occurred.

KnownConnectorOffer

The cassandra connector offer type for the Cosmos DB C* database account.

KnownContinuousTier

Enum to indicate type of Continuous backup tier.

KnownCopyJobMode

Mode of job execution

KnownCopyJobStatus

Job Status

KnownCopyJobType

Copy Job Type

KnownCreateMode

Enum to indicate the mode of account creation.

KnownCreatedByType

The kind of entity that created the resource.

KnownDataTransferComponent

Known values of DataTransferComponent that the service accepts.

KnownDataTransferJobMode

Mode of job execution

KnownDataType

The datatype for which the indexing behavior is applied to.

KnownDatabaseAccountKind

Indicates the type of database account. This can only be set at database account creation.

KnownDedicatedGatewayType

DedicatedGatewayType for the service.

KnownDefaultPriorityLevel

Enum to indicate default priorityLevel of requests

KnownDistanceFunction

The distance function to use for distance calculation in between vectors.

KnownFleetAnalyticsPropertiesStorageLocationType

The type of the fleet analytics resource.

KnownFleetspacePropertiesFleetspaceApiKind

The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'

KnownFleetspacePropertiesServiceTier

Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.

KnownGarnetCacheProvisioningState

The status of the resource at the time the operation was called.

KnownIndexKind

Indicates the type of index.

KnownIndexingMode

Indicates the indexing mode.

KnownIssueType

Type of issue

KnownKeyKind

The access key to regenerate.

KnownKind

Kind of the connection string key

KnownManagedCassandraProvisioningState

The status of the resource at the time the operation was called.

KnownManagedCassandraResourceIdentityType

The type of the resource.

KnownMinimalTlsVersion

Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.

KnownNetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of a network security perimeter configuration that is being created or updated.

KnownNodeState

The state of the node in Cassandra ring.

KnownNotebookWorkspaceName

Known values of NotebookWorkspaceName that the service accepts.

KnownOperationType

Enum to indicate the operation type of the event.

KnownPartitionKind

Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create

KnownPrimaryAggregationType

The primary aggregation type of the metric.

KnownPublicNetworkAccess

Whether requests from Public Network are allowed

KnownResourceAssociationAccessMode

Access mode of the resource association

KnownRestoreMode

Describes the mode of the restore.

KnownScheduledEventStrategy

How the nodes in the cluster react to scheduled events

KnownServerVersion

Describes the version of the MongoDB account.

KnownServiceSize

Instance type for the service.

KnownServiceStatus

Describes the status of a service.

KnownServiceType

ServiceType for the service.

KnownSeverity

Severity of the issue.

KnownSpatialType

Indicates the spatial type of index.

KnownStatus

Enum to indicate current buildout status of the region.

KnownThroughputPolicyType

ThroughputPolicy to apply for throughput redistribution

KnownTriggerOperation

The operation the trigger is associated with

KnownTriggerType

Type of the Trigger

KnownType

Type of the connection string

KnownUnitType

The unit of the metric.

KnownVectorDataType

Indicates the data type of vector.

KnownVectorIndexType

The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(CosmosDBManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(CosmosDBManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: CosmosDBManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>