# Packages
No description provided by the author
# Functions
New creates an instance of the BaseClient client.
NewCollectionClient creates an instance of the CollectionClient client.
NewCollectionClientWithBaseURI creates an instance of the CollectionClient client using a custom endpoint.
NewCollectionPartitionClient creates an instance of the CollectionPartitionClient client.
NewCollectionPartitionClientWithBaseURI creates an instance of the CollectionPartitionClient client using a custom endpoint.
NewCollectionPartitionRegionClient creates an instance of the CollectionPartitionRegionClient client.
NewCollectionPartitionRegionClientWithBaseURI creates an instance of the CollectionPartitionRegionClient client using a custom endpoint.
NewCollectionRegionClient creates an instance of the CollectionRegionClient client.
NewCollectionRegionClientWithBaseURI creates an instance of the CollectionRegionClient client using a custom endpoint.
NewDatabaseAccountRegionClient creates an instance of the DatabaseAccountRegionClient client.
NewDatabaseAccountRegionClientWithBaseURI creates an instance of the DatabaseAccountRegionClient client using a custom endpoint.
NewDatabaseAccountsClient creates an instance of the DatabaseAccountsClient client.
NewDatabaseAccountsClientWithBaseURI creates an instance of the DatabaseAccountsClient client using a custom endpoint.
NewDatabaseClient creates an instance of the DatabaseClient client.
NewDatabaseClientWithBaseURI creates an instance of the DatabaseClient client using a custom endpoint.
Creates a new instance of the OperationListResultIterator type.
Creates a new instance of the OperationListResultPage type.
NewOperationsClient creates an instance of the OperationsClient client.
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint.
NewPartitionKeyRangeIDClient creates an instance of the PartitionKeyRangeIDClient client.
NewPartitionKeyRangeIDClientWithBaseURI creates an instance of the PartitionKeyRangeIDClient client using a custom endpoint.
NewPartitionKeyRangeIDRegionClient creates an instance of the PartitionKeyRangeIDRegionClient client.
NewPartitionKeyRangeIDRegionClientWithBaseURI creates an instance of the PartitionKeyRangeIDRegionClient client using a custom endpoint.
NewPercentileClient creates an instance of the PercentileClient client.
NewPercentileClientWithBaseURI creates an instance of the PercentileClient client using a custom endpoint.
NewPercentileSourceTargetClient creates an instance of the PercentileSourceTargetClient client.
NewPercentileSourceTargetClientWithBaseURI creates an instance of the PercentileSourceTargetClient client using a custom endpoint.
NewPercentileTargetClient creates an instance of the PercentileTargetClient client.
NewPercentileTargetClientWithBaseURI creates an instance of the PercentileTargetClient client using a custom endpoint.
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint.
PossibleConflictResolutionModeValues returns an array of possible values for the ConflictResolutionMode const type.
PossibleConnectorOfferValues returns an array of possible values for the ConnectorOffer const type.
PossibleDatabaseAccountKindValues returns an array of possible values for the DatabaseAccountKind const type.
PossibleDatabaseAccountOfferTypeValues returns an array of possible values for the DatabaseAccountOfferType const type.
PossibleDataTypeValues returns an array of possible values for the DataType const type.
PossibleDefaultConsistencyLevelValues returns an array of possible values for the DefaultConsistencyLevel const type.
PossibleIndexingModeValues returns an array of possible values for the IndexingMode const type.
PossibleIndexKindValues returns an array of possible values for the IndexKind const type.
PossibleKeyKindValues returns an array of possible values for the KeyKind const type.
PossiblePartitionKindValues returns an array of possible values for the PartitionKind const type.
PossiblePrimaryAggregationTypeValues returns an array of possible values for the PrimaryAggregationType const type.
PossibleUnitTypeValues returns an array of possible values for the UnitType const type.
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
# Constants
BoundedStaleness ...
Bytes ...
BytesPerSecond ...
Consistent ...
ConsistentPrefix ...
Count ...
CountPerSecond ...
Custom ...
DefaultBaseURI is the default URI used for the service Documentdb.
Eventual ...
GlobalDocumentDB ...
Hash ...
LastWriterWins ...
Lazy ...
LineString ...
Milliseconds ...
MongoDB ...
MultiPolygon ...
None ...
Number ...
Parse ...
PartitionKindHash ...
PartitionKindRange ...
Percent ...
Point ...
Polygon ...
Primary ...
PrimaryAggregationTypeAverage ...
PrimaryAggregationTypeLast ...
PrimaryAggregationTypeMaximum ...
PrimaryAggregationTypeMinimum ...
PrimaryAggregationTypeNone ...
PrimaryAggregationTypeTotal ...
PrimaryReadonly ...
Range ...
Secondary ...
SecondaryReadonly ...
Seconds ...
Session ...
Small ...
Spatial ...
Standard ...
String ...
Strong ...
# Structs
BaseClient is the base client for Documentdb.
Capability cosmos DB capability object.
CassandraKeyspace an Azure Cosmos DB Cassandra keyspace.
CassandraKeyspaceCreateUpdateParameters parameters to create and update Cosmos DB Cassandra keyspace.
CassandraKeyspaceCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra keyspace.
CassandraKeyspaceListResult the List operation response, that contains the Cassandra keyspaces and their properties.
CassandraKeyspaceProperties the properties of an Azure Cosmos DB Cassandra keyspace.
CassandraKeyspaceResource cosmos DB Cassandra keyspace id object.
CassandraPartitionKey cosmos DB Cassandra table partition key.
CassandraSchema cosmos DB Cassandra table schema.
CassandraTable an Azure Cosmos DB Cassandra table.
CassandraTableCreateUpdateParameters parameters to create and update Cosmos DB Cassandra table.
CassandraTableCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra table.
CassandraTableListResult the List operation response, that contains the Cassandra tables and their properties.
CassandraTableProperties the properties of an Azure Cosmos DB Cassandra table.
CassandraTableResource cosmos DB Cassandra table id object.
ClusterKey cosmos DB Cassandra table cluster key.
CollectionClient is the azure Cosmos DB Database Service Resource Provider REST API.
CollectionPartitionClient is the azure Cosmos DB Database Service Resource Provider REST API.
CollectionPartitionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API.
CollectionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API.
Column cosmos DB Cassandra table column.
ConflictResolutionPolicy the conflict resolution policy for the container.
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.
DatabaseAccount an Azure Cosmos DB database account.
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.
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.
DatabaseAccountPatchParameters parameters for patching Azure Cosmos DB database account properties.
DatabaseAccountPatchProperties properties to update Azure Cosmos DB database accounts.
DatabaseAccountProperties properties for the database account.
DatabaseAccountRegenerateKeyParameters parameters to regenerate the keys within the database account.
DatabaseAccountRegionClient is the azure Cosmos DB Database Service Resource Provider REST API.
DatabaseAccountsClient is the azure Cosmos DB Database Service Resource Provider REST API.
DatabaseAccountsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateSQLContainerFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateSQLDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsCreateUpdateTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteSQLContainerFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteSQLDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsDeleteTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsFailoverPriorityChangeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsListResult the List operation response, that contains the database accounts and their properties.
DatabaseAccountsOfflineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsOnlineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsPatchFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsRegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateCassandraKeyspaceThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateCassandraTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateGremlinDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateGremlinGraphThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateMongoDBCollectionThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateMongoDBDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateSQLContainerThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateSQLDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseAccountsUpdateTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DatabaseClient is the azure Cosmos DB Database Service Resource Provider REST API.
ErrorResponse error Response.
ExcludedPath ...
ExtendedResourceProperties the system generated resource properties associated with SQL databases and SQL containers.
FailoverPolicies the list of new failover policies for the failover priority change.
FailoverPolicy the failover policy for a given region of a database account.
GremlinDatabase an Azure Cosmos DB Gremlin database.
GremlinDatabaseCreateUpdateParameters parameters to create and update Cosmos DB Gremlin database.
GremlinDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin database.
GremlinDatabaseListResult the List operation response, that contains the Gremlin databases and their properties.
GremlinDatabaseProperties the properties of an Azure Cosmos DB SQL database.
GremlinDatabaseResource cosmos DB Gremlin database id object.
GremlinGraph an Azure Cosmos DB Gremlin graph.
GremlinGraphCreateUpdateParameters parameters to create and update Cosmos DB Gremlin graph.
GremlinGraphCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin graph.
GremlinGraphListResult the List operation response, that contains the graphs and their properties.
GremlinGraphProperties the properties of an Azure Cosmos DB Gremlin graph.
GremlinGraphResource cosmos DB Gremlin graph resource object.
IncludedPath the paths that are included in indexing.
Indexes the indexes for the path.
IndexingPolicy cosmos DB indexing policy.
Location a region in which the Azure Cosmos DB database account is deployed.
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.
MongoDBCollection an Azure Cosmos DB MongoDB collection.
MongoDBCollectionCreateUpdateParameters parameters to create and update Cosmos DB MongoDB collection.
MongoDBCollectionCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB collection.
MongoDBCollectionListResult the List operation response, that contains the MongoDB collections and their properties.
MongoDBCollectionProperties the properties of an Azure Cosmos DB MongoDB collection.
MongoDBCollectionResource cosmos DB MongoDB collection resource object.
MongoDBDatabase an Azure Cosmos DB MongoDB database.
MongoDBDatabaseCreateUpdateParameters parameters to create and update Cosmos DB MongoDB database.
MongoDBDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB database.
MongoDBDatabaseListResult the List operation response, that contains the MongoDB databases and their properties.
MongoDBDatabaseProperties the properties of an Azure Cosmos DB MongoDB database.
MongoDBDatabaseResource cosmos DB MongoDB database id object.
MongoIndex cosmos DB MongoDB collection index key.
MongoIndexKeys cosmos DB MongoDB collection resource object.
MongoIndexOptions cosmos DB MongoDB collection index options.
Operation REST API operation.
OperationDisplay the object that represents the operation.
OperationListResult result of the request to list Resource Provider operations.
OperationListResultIterator provides access to a complete listing of Operation values.
OperationListResultPage contains a page of Operation values.
OperationsClient is the azure Cosmos DB Database Service Resource Provider REST API.
PartitionKeyRangeIDClient is the azure Cosmos DB Database Service Resource Provider REST API.
PartitionKeyRangeIDRegionClient is the azure Cosmos DB Database Service Resource Provider REST API.
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.
PercentileClient is the azure Cosmos DB Database Service Resource Provider REST API.
PercentileMetric percentile Metric data.
PercentileMetricListResult the response to a list percentile metrics request.
PercentileMetricValue represents percentile metrics values.
PercentileSourceTargetClient is the azure Cosmos DB Database Service Resource Provider REST API.
PercentileTargetClient is the azure Cosmos DB Database Service Resource Provider REST API.
RegionForOnlineOffline cosmos DB region to online or offline.
Resource the core properties of ARM resources.
SQLContainer an Azure Cosmos DB container.
SQLContainerCreateUpdateParameters parameters to create and update Cosmos DB container.
SQLContainerCreateUpdateProperties properties to create and update Azure Cosmos DB container.
SQLContainerListResult the List operation response, that contains the containers and their properties.
SQLContainerProperties the properties of an Azure Cosmos DB container.
SQLContainerResource cosmos DB SQL container resource object.
SQLDatabase an Azure Cosmos DB SQL database.
SQLDatabaseCreateUpdateParameters parameters to create and update Cosmos DB SQL database.
SQLDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB SQL database.
SQLDatabaseListResult the List operation response, that contains the SQL databases and their properties.
SQLDatabaseProperties the properties of an Azure Cosmos DB SQL database.
SQLDatabaseResource cosmos DB SQL database id object.
Table an Azure Cosmos DB Table.
TableCreateUpdateParameters parameters to create and update Cosmos DB Table.
TableCreateUpdateProperties properties to create and update Azure Cosmos DB Table.
TableListResult the List operation response, that contains the Table and their properties.
TableProperties the properties of an Azure Cosmos Table.
TableResource cosmos DB table id object.
Throughput an Azure Cosmos DB resource throughput.
ThroughputProperties the properties of an Azure Cosmos DB resource throughput.
ThroughputResource cosmos DB resource throughput object.
ThroughputUpdateParameters parameters to update Cosmos DB resource throughput.
ThroughputUpdateProperties properties to update Azure 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
ConflictResolutionMode enumerates the values for conflict resolution mode.
ConnectorOffer enumerates the values for connector offer.
DatabaseAccountKind enumerates the values for database account kind.
DatabaseAccountOfferType enumerates the values for database account offer type.
DataType enumerates the values for data type.
DefaultConsistencyLevel enumerates the values for default consistency level.
IndexingMode enumerates the values for indexing mode.
IndexKind enumerates the values for index kind.
KeyKind enumerates the values for key kind.
PartitionKind enumerates the values for partition kind.
PrimaryAggregationType enumerates the values for primary aggregation type.
UnitType enumerates the values for unit type.