Microsoft Azure - API Cosmos DB

Microsoft Azure / Cosmos DB

Cosmos DB

Azure Cosmos DB Database Service Resource Provider REST API

Resources

Operations

GET

/providers/Microsoft.DocumentDB/operations

Lists all of the available Cosmos DB Resource Provider operations.

Request

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200OK

Body

Name	Data Type	Description
`OperationListResult`		Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

Properties


                        value

array [Operation]

List of operations supported by the Resource Provider.


                        Operation

object

REST API operation

Properties

`name`	string	Operation name: {provider}/{resource}/{operation}
`display`


                        nextLink

string

URL to get the next set of operation list results if there are any.

default

HEAD

/providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}

Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200OK. The account name is valid but is already in use.

404Not Found. The account name is available and valid.

GET

/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts

Lists all the Azure Cosmos DB database accounts available under the subscription.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The operation completed successfully.

Body

Name	Data Type	Description
`DatabaseAccountsListResult`		The List operation response, that contains the database accounts and their properties.

Properties


                        value

array [DatabaseAccount]

List of database account and their properties.


                        DatabaseAccount

object

An Azure Cosmos DB database account.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties

`writeLocations`	array [Location]	An array that contains the write location for the Cosmos DB account.
`virtualNetworkRules`	array [VirtualNetworkRule]	List of Virtual Network ACL rules configured for the Cosmos DB account.
`readLocations`	array [Location]	An array that contains of the read locations enabled for the Cosmos DB account.
`provisioningState`	ProvisioningState
`isVirtualNetworkFilterEnabled`	boolean	Flag to indicate whether to enable/disable Virtual Network ACL rules.
`ipRangeFilter`	IPRangeFilter	Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
`failoverPolicies`	array [FailoverPolicy]	An array that contains the regions ordered by their failover priorities.
`enableMultipleWriteLocations`	boolean	Enables the account to write in multiple locations
`enableAutomaticFailover`	boolean	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
`documentEndpoint`	string Read-only	The connection endpoint for the Cosmos DB database account.
`databaseAccountOfferType`	DatabaseAccountOfferType Read-only	The offer type for the Cosmos DB database account. Default value: Standard.
`consistencyPolicy`	ConsistencyPolicy	The consistency policy for the Cosmos DB database account.
`capabilities`	array [Capability]	List of Cosmos DB capabilities for the account


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions

Retrieves metric definitions for the given collection.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metric definitions for the collection were retrieved successfully.

Body

Name	Data Type	Description
`MetricDefinitionsListResult`		The response to a list metric definitions request.

Properties


                        value

array [MetricDefinition]

The list of metric definitions for the account.


                        MetricDefinition

The definition of a metric.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        resourceUri

string
Read-only

The resource uri of the database.


                        primaryAggregationType

string
Read-only
Allowed values:
- None
- Average
- Total
- Minimimum
- Maximum
- Last

The primary aggregation type of the metric.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricAvailabilities

array [MetricAvailability]

The list of metric availabilities for the account.


                        MetricAvailability

The availability of the metric.

Properties

`timeGrain`	string Read-only	The time grain to be used to summarize the metric values.
`retention`	string Read-only	The retention for the metric values.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics

Retrieves the metrics determined by the given filter for the given database account and collection.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metrics for the database account were retrieved successfully.

Body

Name	Data Type	Description
`MetricListResult`		The response to a list metrics request.

Properties


                        value

array [Metric]

The list of metrics for the account.


                        Metric

Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics

Retrieves the metrics determined by the given filter for the given partition key range id.

Request

Path

Name	Data Type	Description
`partitionKeyRangeId`	string	Partition Key Range Id for which to get data.
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The partition-level metrics for the partition key range id were retrieved successfully.

Body

Name	Data Type	Description
`PartitionMetricListResult`		The response to a list partition metrics request.

Properties


                        value

array [PartitionMetric]

The list of partition-level metrics for the account.


                        PartitionMetric

The metric values for a single partition.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).


                        partitionKeyRangeId

string
Read-only

The partition key range id (integer identifier) of the metric values.


                        partitionId

string
Read-only

The partition id (GUID identifier) of the metric values.

Extends

Metric

Metric data

Properties

Name Data Type Description


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics

Retrieves the metrics determined by the given filter for the given collection, split by partition.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The partition-level metrics for the collection were retrieved successfully.

Body

Name	Data Type	Description
`PartitionMetricListResult`		The response to a list partition metrics request.

Properties


                        value

array [PartitionMetric]

The list of partition-level metrics for the account.


                        PartitionMetric

The metric values for a single partition.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).


                        partitionKeyRangeId

string
Read-only

The partition key range id (integer identifier) of the metric values.


                        partitionId

string
Read-only

The partition id (GUID identifier) of the metric values.

Extends

Metric

Metric data

Properties

Name Data Type Description


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages

Retrieves the usages (most recent storage data) for the given collection, split by partition.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The usages for the collection, per partition were retrieved successfully.

Body

Name	Data Type	Description
`PartitionUsagesResult`		The response to a list partition level usage request.

Properties


                        value

array [PartitionUsage]

The list of partition-level usages for the database. A usage is a point in time metric


                        PartitionUsage

The partition level usage data for a usage request.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        quotaPeriod

string
Read-only

The quota period used to summarize the usage values.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        limit

integer
Read-only

Maximum value for this metric


                        currentValue

integer
Read-only

Current value for this metric


                        partitionKeyRangeId

string
Read-only

The partition key range id (integer identifier) of the usages.


                        partitionId

string
Read-only

The partition id (GUID identifier) of the usages.

Extends

Usage

The usage data for a usage request.

Properties

Name Data Type Description


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        quotaPeriod

string
Read-only

The quota period used to summarize the usage values.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        limit

integer
Read-only

Maximum value for this metric


                        currentValue

integer
Read-only

Current value for this metric

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages

Retrieves the usages (most recent storage data) for the given collection.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The usages for the collection were retrieved successfully.

Body

Name	Data Type	Description
`UsagesResult`		The response to a list usage request.

Properties


                        value

array [Usage]

The list of usages for the database. A usage is a point in time metric


                        Usage

The usage data for a usage request.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        quotaPeriod

string
Read-only

The quota period used to summarize the usage values.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        limit

integer
Read-only

Maximum value for this metric


                        currentValue

integer
Read-only

Current value for this metric

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions

Retrieves metric definitions for the given database.

Request

Path

Name	Data Type	Description
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metric definitions for the database were retrieved successfully.

Body

Name	Data Type	Description
`MetricDefinitionsListResult`		The response to a list metric definitions request.

Properties


                        value

array [MetricDefinition]

The list of metric definitions for the account.


                        MetricDefinition

The definition of a metric.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        resourceUri

string
Read-only

The resource uri of the database.


                        primaryAggregationType

string
Read-only
Allowed values:
- None
- Average
- Total
- Minimimum
- Maximum
- Last

The primary aggregation type of the metric.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricAvailabilities

array [MetricAvailability]

The list of metric availabilities for the account.


                        MetricAvailability

The availability of the metric.

Properties

`timeGrain`	string Read-only	The time grain to be used to summarize the metric values.
`retention`	string Read-only	The retention for the metric values.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics

Retrieves the metrics determined by the given filter for the given database account and database.

Request

Path

Name	Data Type	Description
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metrics for the database account were retrieved successfully.

Body

Name	Data Type	Description
`MetricListResult`		The response to a list metrics request.

Properties


                        value

array [Metric]

The list of metrics for the account.


                        Metric

Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages

Retrieves the usages (most recent data) for the given database.

Request

Path

Name	Data Type	Description
`databaseRid`	string	Cosmos DB database rid.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The usages for the database were retrieved successfully.

Body

Name	Data Type	Description
`UsagesResult`		The response to a list usage request.

Properties


                        value

array [Usage]

The list of usages for the database. A usage is a point in time metric


                        Usage

The usage data for a usage request.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        quotaPeriod

string
Read-only

The quota period used to summarize the usage values.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        limit

integer
Read-only

Maximum value for this metric


                        currentValue

integer
Read-only

Current value for this metric

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange

Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Body

Name	Data Type	Description
`FailoverPolicies`		The list of new failover policies for the failover priority change.

Properties


                        failoverPolicies

array [FailoverPolicy]

List of failover policies.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

Responses

202Accepted. The failover policy change operation will complete asynchronously.

204No Content

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings

Lists the connection strings for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The operation completed successfully.

Body

Name	Data Type	Description
`DatabaseAccountListConnectionStringsResult`		The connection strings for the given database account.

Properties


                        connectionStrings

array [DatabaseAccountConnectionString]

An array that contains the connection strings for the Cosmos DB account.


                        DatabaseAccountConnectionString

Connection string for the Cosmos DB account

Properties

`description`	string Read-only	Description of the connection string
`connectionString`	string Read-only	Value of the connection string

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys

Lists the access keys for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The operation completed successfully.

Body

Name	Data Type	Description
`DatabaseAccountListKeysResult`		The access keys for the given database account.

Properties


                        secondaryMasterKey

string
Read-only

Base 64 encoded value of the secondary read-write key.

properties DatabaseAccountListReadOnlyKeysResult


                        DatabaseAccountListReadOnlyKeysResult

The read-only access keys for the given database account.

Properties

`secondaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the secondary read-only key.
`primaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the primary read-only key.


                        primaryMasterKey

string
Read-only

Base 64 encoded value of the primary read-write key.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions

Retrieves metric definitions for the given database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metric definitions for the database account were retrieved successfully.

Body

Name	Data Type	Description
`MetricDefinitionsListResult`		The response to a list metric definitions request.

Properties


                        value

array [MetricDefinition]

The list of metric definitions for the account.


                        MetricDefinition

The definition of a metric.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        resourceUri

string
Read-only

The resource uri of the database.


                        primaryAggregationType

string
Read-only
Allowed values:
- None
- Average
- Total
- Minimimum
- Maximum
- Last

The primary aggregation type of the metric.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricAvailabilities

array [MetricAvailability]

The list of metric availabilities for the account.


                        MetricAvailability

The availability of the metric.

Properties

`timeGrain`	string Read-only	The time grain to be used to summarize the metric values.
`retention`	string Read-only	The retention for the metric values.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics

Retrieves the metrics determined by the given filter for the given database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metrics for the database account were retrieved successfully.

Body

Name	Data Type	Description
`MetricListResult`		The response to a list metrics request.

Properties


                        value

array [Metric]

The list of metrics for the account.


                        Metric

Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion

Offline the specified region for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Body

Name	Data Type	Description
`RegionForOnlineOffline`		Cosmos DB region to online or offline.

Properties


                        region

string

Cosmos DB region, with spaces between words and each word capitalized.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`ErrorResponse`		Error Response.

Properties

`message`	string	Error message indicating why the operation failed.
`code`	string	Error code.

200The offline region operation is completed successfully.

202Accepted. The offline region operation will complete asynchronously.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion

Online the specified region for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Body

Name	Data Type	Description
`RegionForOnlineOffline`		Cosmos DB region to online or offline.

Properties


                        region

string

Cosmos DB region, with spaces between words and each word capitalized.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`ErrorResponse`		Error Response.

Properties

`message`	string	Error message indicating why the operation failed.
`code`	string	Error code.

200The online region operation is completed successfully.

202Accepted. The online region operation will complete asynchronously.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics

Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The percentile metrics for the account were retrieved successfully.

Body

Name	Data Type	Description
`PercentileMetricListResult`		The response to a list percentile metrics request.

Properties


                        value

array [PercentileMetric]

The list of percentile metrics for the account.


                        PercentileMetric

Percentile Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [PercentileMetricValue]

The percentile metric values for the specified time window and timestep.


                        PercentileMetricValue

Represents percentile metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.
`P99`	double Read-only	The 99th percentile value for the metric.
`P95`	double Read-only	The 95th percentile value for the metric.
`P90`	double Read-only	The 90th percentile value for the metric.
`P75`	double Read-only	The 75th percentile value for the metric.
`P50`	double Read-only	The 50th percentile value for the metric.
`P25`	double Read-only	The 25th percentile value for the metric.
`P10`	double Read-only	The 10th percentile value for the metric.

Extends

MetricValue

Represents metrics values.

Properties

Name	Data Type	Description
`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys

Lists the read-only access keys for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The operation completed successfully.

Body

Name	Data Type	Description
`DatabaseAccountListReadOnlyKeysResult`		The read-only access keys for the given database account.

Properties

`secondaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the secondary read-only key.
`primaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the primary read-only key.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys

Lists the read-only access keys for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The operation completed successfully.

Body

Name	Data Type	Description
`DatabaseAccountListReadOnlyKeysResult`		The read-only access keys for the given database account.

Properties

`secondaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the secondary read-only key.
`primaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the primary read-only key.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey

Regenerates an access key for the specified Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Body

Name	Data Type	Description
`DatabaseAccountRegenerateKeyParameters`	object	Parameters to regenerate the keys within the database account.

Properties


                        keyKind

string
Allowed values:
- primary
- secondary
- primaryReadonly
- secondaryReadonly

The access key to regenerate.

Responses

200OK

202Accepted. The regenerate key operation will complete asynchronously.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics

Retrieves the metrics determined by the given filter for the given database account, collection and region.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`region`	string	Cosmos DB region, with spaces between words and each word capitalized.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metrics for the database account were retrieved successfully.

Body

Name	Data Type	Description
`MetricListResult`		The response to a list metrics request.

Properties


                        value

array [Metric]

The list of metrics for the account.


                        Metric

Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Request

Path

Name	Data Type	Description
`partitionKeyRangeId`	string	Partition Key Range Id for which to get data.
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`region`	string	Cosmos DB region, with spaces between words and each word capitalized.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The partition-level metrics for the partition key range id and region were retrieved successfully.

Body

Name	Data Type	Description
`PartitionMetricListResult`		The response to a list partition metrics request.

Properties


                        value

array [PartitionMetric]

The list of partition-level metrics for the account.


                        PartitionMetric

The metric values for a single partition.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).


                        partitionKeyRangeId

string
Read-only

The partition key range id (integer identifier) of the metric values.


                        partitionId

string
Read-only

The partition id (GUID identifier) of the metric values.

Extends

Metric

Metric data

Properties

Name Data Type Description


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

Request

Path

Name	Data Type	Description
`collectionRid`	string	Cosmos DB collection rid.
`databaseRid`	string	Cosmos DB database rid.
`region`	string	Cosmos DB region, with spaces between words and each word capitalized.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The partition-level metrics for the collection and region were retrieved successfully.

Body

Name	Data Type	Description
`PartitionMetricListResult`		The response to a list partition metrics request.

Properties


                        value

array [PartitionMetric]

The list of partition-level metrics for the account.


                        PartitionMetric

The metric values for a single partition.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).


                        partitionKeyRangeId

string
Read-only

The partition key range id (integer identifier) of the metric values.


                        partitionId

string
Read-only

The partition id (GUID identifier) of the metric values.

Extends

Metric

Metric data

Properties

Name Data Type Description


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics

Retrieves the metrics determined by the given filter for the given database account and region.

Request

Path

Name	Data Type	Description
`region`	string	Cosmos DB region, with spaces between words and each word capitalized.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The metrics for the database account were retrieved successfully.

Body

Name	Data Type	Description
`MetricListResult`		The response to a list metrics request.

Properties


                        value

array [Metric]

The list of metrics for the account.


                        Metric

Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics

Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data

Request

Path

Name	Data Type	Description
`targetRegion`	string	Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized.
`sourceRegion`	string	Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The percentile metrics for the account, source and target regions were retrieved successfully.

Body

Name	Data Type	Description
`PercentileMetricListResult`		The response to a list percentile metrics request.

Properties


                        value

array [PercentileMetric]

The list of percentile metrics for the account.


                        PercentileMetric

Percentile Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [PercentileMetricValue]

The percentile metric values for the specified time window and timestep.


                        PercentileMetricValue

Represents percentile metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.
`P99`	double Read-only	The 99th percentile value for the metric.
`P95`	double Read-only	The 95th percentile value for the metric.
`P90`	double Read-only	The 90th percentile value for the metric.
`P75`	double Read-only	The 75th percentile value for the metric.
`P50`	double Read-only	The 50th percentile value for the metric.
`P25`	double Read-only	The 25th percentile value for the metric.
`P10`	double Read-only	The 10th percentile value for the metric.

Extends

MetricValue

Represents metrics values.

Properties

Name	Data Type	Description
`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics

Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data

Request

Path

Name	Data Type	Description
`targetRegion`	string	Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized.
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The percentile metrics for the account and target regions were retrieved successfully.

Body

Name	Data Type	Description
`PercentileMetricListResult`		The response to a list percentile metrics request.

Properties


                        value

array [PercentileMetric]

The list of percentile metrics for the account.


                        PercentileMetric

Percentile Metric data

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [PercentileMetricValue]

The percentile metric values for the specified time window and timestep.


                        PercentileMetricValue

Represents percentile metrics values.

Properties

`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.
`P99`	double Read-only	The 99th percentile value for the metric.
`P95`	double Read-only	The 95th percentile value for the metric.
`P90`	double Read-only	The 90th percentile value for the metric.
`P75`	double Read-only	The 75th percentile value for the metric.
`P50`	double Read-only	The 50th percentile value for the metric.
`P25`	double Read-only	The 25th percentile value for the metric.
`P10`	double Read-only	The 10th percentile value for the metric.

Extends

MetricValue

Represents metrics values.

Properties

Name	Data Type	Description
`total`	double Read-only	The total value of the metric.
`timestamp`	dateTime Read-only	The metric timestamp (ISO-8601 format).
`minimum`	double Read-only	The min value of the metric.
`maximum`	double Read-only	The max value of the metric.
`average`	double Read-only	The average value of the metric.
`_count`	double Read-only	The number of values for the metric.


                        endTime

dateTime
Read-only

The end time for the metric (ISO-8601 format).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages

Retrieves the usages (most recent data) for the given database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`$filter`	string	An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The usages for the database account were retrieved successfully.

Body

Name	Data Type	Description
`UsagesResult`		The response to a list usage request.

Properties


                        value

array [Usage]

The list of usages for the database. A usage is a point in time metric


                        Usage

The usage data for a usage request.

Properties


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        quotaPeriod

string
Read-only

The quota period used to summarize the usage values.


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        limit

integer
Read-only

Maximum value for this metric


                        currentValue

integer
Read-only

Current value for this metric

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}

Deletes an existing Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

202The database account delete operation will complete asynchronously.

204The specified account does not exist in the subscription.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}

Retrieves the properties of an existing Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The database account properties were retrieved successfully.

Body

Name	Data Type	Description
`DatabaseAccount`	object	An Azure Cosmos DB database account.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties


                        writeLocations

array [Location]

An array that contains the write location for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        readLocations

array [Location]

An array that contains of the read locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState ProvisioningState


                        ProvisioningState

string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation.


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter

Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.


                        IPRangeFilter

string


                        failoverPolicies

array [FailoverPolicy]

An array that contains the regions ordered by their failover priorities.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean

Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.


                        documentEndpoint

string
Read-only

The connection endpoint for the Cosmos DB database account.


                        databaseAccountOfferType

DatabaseAccountOfferType
Read-only

The offer type for the Cosmos DB database account. Default value: Standard.


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}

Patches the properties of an existing Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Body

Name	Data Type	Description
`DatabaseAccountPatchParameters`	object	Parameters for patching Azure Cosmos DB database account properties.

Properties

tags Tags


                        Tags

object

properties DatabaseAccountPatchProperties


                        DatabaseAccountPatchProperties

object

Properties to update Azure Cosmos DB database accounts.

Properties


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

Responses

200The properties of the database account were patched successfully.

Body

Name	Data Type	Description
`DatabaseAccount`	object	An Azure Cosmos DB database account.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties


                        writeLocations

array [Location]

An array that contains the write location for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        readLocations

array [Location]

An array that contains of the read locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState ProvisioningState


                        ProvisioningState

string


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        failoverPolicies

array [FailoverPolicy]

An array that contains the regions ordered by their failover priorities.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean


                        documentEndpoint

string
Read-only

The connection endpoint for the Cosmos DB database account.


                        databaseAccountOfferType

DatabaseAccountOfferType
Read-only

The offer type for the Cosmos DB database account. Default value: Standard.


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}

Creates or updates an Azure Cosmos DB database account.

Request

Path

Name	Data Type	Description
`accountName`	string Minimum: 3 Maximum: 50	Cosmos DB database account name.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.
`subscriptionId`	string	Azure subscription ID.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Body

Name	Data Type	Description
`DatabaseAccountCreateUpdateParameters`	object	Parameters to create and update Cosmos DB database accounts.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountCreateUpdateProperties


                        DatabaseAccountCreateUpdateProperties

object

Properties to create and update Azure Cosmos DB database accounts.

Properties


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        locations

array [Location]

An array that contains the georeplication locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean

databaseAccountOfferType DatabaseAccountOfferType


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

Responses

200The database account create or update operation will complete asynchronously.

Body

Name	Data Type	Description
`DatabaseAccount`	object	An Azure Cosmos DB database account.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties


                        writeLocations

array [Location]

An array that contains the write location for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        readLocations

array [Location]

An array that contains of the read locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState ProvisioningState


                        ProvisioningState

string


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        failoverPolicies

array [FailoverPolicy]

An array that contains the regions ordered by their failover priorities.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean


                        documentEndpoint

string
Read-only

The connection endpoint for the Cosmos DB database account.


                        databaseAccountOfferType

DatabaseAccountOfferType
Read-only

The offer type for the Cosmos DB database account. Default value: Standard.


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts

Lists all the Azure Cosmos DB database accounts available under the given resource group.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Azure subscription ID.
`resourceGroupName`	string Pattern: `^[-\w\._]+$` Minimum: 1 Maximum: 90	Name of an Azure resource group.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request. The current version is 2015-04-08.

Responses

200The operation completed successfully.

Body

Name	Data Type	Description
`DatabaseAccountsListResult`		The List operation response, that contains the database accounts and their properties.

Properties


                        value

array [DatabaseAccount]

List of database account and their properties.


                        DatabaseAccount

object

An Azure Cosmos DB database account.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties

`writeLocations`	array [Location]	An array that contains the write location for the Cosmos DB account.
`virtualNetworkRules`	array [VirtualNetworkRule]	List of Virtual Network ACL rules configured for the Cosmos DB account.
`readLocations`	array [Location]	An array that contains of the read locations enabled for the Cosmos DB account.
`provisioningState`	ProvisioningState
`isVirtualNetworkFilterEnabled`	boolean	Flag to indicate whether to enable/disable Virtual Network ACL rules.
`ipRangeFilter`	IPRangeFilter	Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
`failoverPolicies`	array [FailoverPolicy]	An array that contains the regions ordered by their failover priorities.
`enableMultipleWriteLocations`	boolean	Enables the account to write in multiple locations
`enableAutomaticFailover`	boolean	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
`documentEndpoint`	string Read-only	The connection endpoint for the Cosmos DB database account.
`databaseAccountOfferType`	DatabaseAccountOfferType Read-only	The offer type for the Cosmos DB database account. Default value: Standard.
`consistencyPolicy`	ConsistencyPolicy	The consistency policy for the Cosmos DB database account.
`capabilities`	array [Capability]	List of Cosmos DB capabilities for the account


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

Models

Capability

ConsistencyPolicy

DatabaseAccount

An Azure Cosmos DB database account.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties


                        writeLocations

array [Location]

An array that contains the write location for the Cosmos DB account.


                        Location

object

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

Properties

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0

The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        readLocations

array [Location]

An array that contains of the read locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState ProvisioningState


                        ProvisioningState

string


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        failoverPolicies

array [FailoverPolicy]

An array that contains the regions ordered by their failover priorities.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean


                        documentEndpoint

string
Read-only

The connection endpoint for the Cosmos DB database account.


                        databaseAccountOfferType

DatabaseAccountOfferType
Read-only

The offer type for the Cosmos DB database account. Default value: Standard.


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

DatabaseAccountConnectionString

DatabaseAccountCreateUpdateParameters

Parameters to create and update Cosmos DB database accounts.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountCreateUpdateProperties


                        DatabaseAccountCreateUpdateProperties

object

Properties to create and update Azure Cosmos DB database accounts.

Properties


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        locations

array [Location]

An array that contains the georeplication locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean

databaseAccountOfferType DatabaseAccountOfferType


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

DatabaseAccountCreateUpdateProperties

Properties to create and update Azure Cosmos DB database accounts.

Properties

Name Data Type Description


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        locations

array [Location]

An array that contains the georeplication locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean

databaseAccountOfferType DatabaseAccountOfferType


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

DatabaseAccountListConnectionStringsResult

DatabaseAccountListKeysResult

The access keys for the given database account.

Properties

Name Data Type Description


                        secondaryMasterKey

string
Read-only

Base 64 encoded value of the secondary read-write key.

properties DatabaseAccountListReadOnlyKeysResult


                        DatabaseAccountListReadOnlyKeysResult

The read-only access keys for the given database account.

Properties

`secondaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the secondary read-only key.
`primaryReadonlyMasterKey`	string Read-only	Base 64 encoded value of the primary read-only key.


                        primaryMasterKey

string
Read-only

Base 64 encoded value of the primary read-write key.

DatabaseAccountListReadOnlyKeysResult

DatabaseAccountOfferType

DatabaseAccountPatchParameters

Parameters for patching Azure Cosmos DB database account properties.

Properties

Name Data Type Description

tags Tags


                        Tags

object

properties DatabaseAccountPatchProperties


                        DatabaseAccountPatchProperties

object

Properties to update Azure Cosmos DB database accounts.

Properties


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

DatabaseAccountPatchProperties

DatabaseAccountProperties

Properties for the database account.

Properties

Name Data Type Description


                        writeLocations

array [Location]

An array that contains the write location for the Cosmos DB account.


                        Location

object

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

Properties

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        readLocations

array [Location]

An array that contains of the read locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState ProvisioningState


                        ProvisioningState

string


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        failoverPolicies

array [FailoverPolicy]

An array that contains the regions ordered by their failover priorities.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean


                        documentEndpoint

string
Read-only

The connection endpoint for the Cosmos DB database account.


                        databaseAccountOfferType

DatabaseAccountOfferType
Read-only

The offer type for the Cosmos DB database account. Default value: Standard.


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

DatabaseAccountRegenerateKeyParameters

DatabaseAccountsListResult

The List operation response, that contains the database accounts and their properties.

Properties

Name Data Type Description


                        value

array [DatabaseAccount]

List of database account and their properties.


                        DatabaseAccount

object

An Azure Cosmos DB database account.

Properties


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

properties DatabaseAccountProperties


                        DatabaseAccountProperties

object

Properties for the database account.

Properties


                        writeLocations

array [Location]

An array that contains the write location for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/


                        virtualNetworkRules

array [VirtualNetworkRule]

List of Virtual Network ACL rules configured for the Cosmos DB account.


                        VirtualNetworkRule

object

Virtual Network ACL Rule object

Properties

`ignoreMissingVNetServiceEndpoint`	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
`id`	string	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.


                        readLocations

array [Location]

An array that contains of the read locations enabled for the Cosmos DB account.


                        Location

object

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

Properties

`provisioningState`	ProvisioningState
`locationName`	string	The name of the region.
`id`	string Read-only	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
`documentEndpoint`	string Read-only	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState ProvisioningState


                        ProvisioningState

string


                        isVirtualNetworkFilterEnabled

boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.


                        ipRangeFilter

IPRangeFilter


                        IPRangeFilter

string


                        failoverPolicies

array [FailoverPolicy]

An array that contains the regions ordered by their failover priorities.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.


                        enableMultipleWriteLocations

boolean

Enables the account to write in multiple locations


                        enableAutomaticFailover

boolean


                        documentEndpoint

string
Read-only

The connection endpoint for the Cosmos DB database account.


                        databaseAccountOfferType

DatabaseAccountOfferType
Read-only

The offer type for the Cosmos DB database account. Default value: Standard.


                        DatabaseAccountOfferType

string
Allowed values:
- Standard

The offer type for the Cosmos DB database account.


                        consistencyPolicy

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.


                        ConsistencyPolicy

object

The consistency policy for the Cosmos DB database account.

Properties

`maxStalenessPrefix`	long Minimum: 1 Maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`maxIntervalInSeconds`	integer Minimum: 5 Maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
`defaultConsistencyLevel`	string Allowed values: - `Eventual` - `Session` - `BoundedStaleness` - `Strong` - `ConsistentPrefix`	The default consistency level and configuration settings of the Cosmos DB account.


                        capabilities

array [Capability]

List of Cosmos DB capabilities for the account


                        Capability

object

Cosmos DB capability object

Properties


                        name

string

Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".


                        kind

string
Default value: GlobalDocumentDB
Allowed values:
- GlobalDocumentDB
- MongoDB
- Parse

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

Extends

Resource

A database account resource.

Properties

Name Data Type Description


                        type

string
Read-only

The type of Azure resource.

tags Tags


                        Tags

object


                        name

string
Read-only

The name of the database account.


                        location

string

The location of the resource group to which the resource belongs.

id

string
Read-only

The unique resource identifier of the database account.

ErrorResponse

FailoverPolicies

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

Properties

Name Data Type Description


                        failoverPolicies

array [FailoverPolicy]

List of failover policies.


                        FailoverPolicy

object

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

Properties

`locationName`	string	The name of the region in which the database account exists.
`id`	string Read-only	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
`failoverPriority`	integer Minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

FailoverPolicy

IPRangeFilter

Location

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

Properties

Name Data Type Description

provisioningState ProvisioningState


                        ProvisioningState

string


                        locationName

string

The name of the region.

id

string
Read-only

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.


                        failoverPriority

integer
Minimum: 0


                        documentEndpoint

string
Read-only

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

Metric

Metric data

Properties

Name Data Type Description


                        unit

UnitType

The unit of the metric.


                        UnitType

string
Allowed values:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
- Milliseconds

The unit of the metric.


                        timeGrain

string
Read-only

The time grain to be used to summarize the metric values.


                        startTime

dateTime
Read-only

The start time for the metric (ISO-8601 format).


                        name

MetricName
Read-only

The name information for the metric.


                        MetricName

A metric name.

Properties

`value`	string Read-only	The name of the metric.
`localizedValue`	string Read-only	The friendly name of the metric.


                        metricValues

array [MetricValue]

The metric values for the specified time window and timestep.


                        MetricValue

Represents metrics values.