Azure Cosmos DB Database Service Resource Provider REST API
Lists all of the available Cosmos DB Resource Provider operations.
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. |
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. |
value
|
array [Operation] |
List of operations supported by the Resource Provider. |
||||||||||
Properties
|
||||||||||||
nextLink
|
string |
URL to get the next set of operation list results if there are any. |
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.
Name | Data Type | Description |
---|---|---|
accountName
|
string Minimum: 3 Maximum: 50 |
Cosmos DB database account name. |
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. |
Lists all the Azure Cosmos DB database accounts available under the subscription.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Azure subscription ID. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountsListResult
|
The List operation response, that contains the database accounts and their properties. |
value
|
array [DatabaseAccount] |
List of database account and their properties. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
A database account resource. Properties
|
Retrieves metric definitions for the given collection.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricDefinitionsListResult
|
The response to a list metric definitions request. |
value
|
array [MetricDefinition] |
The list of metric definitions for the account. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the metrics determined by the given filter for the given database account and collection.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricListResult
|
The response to a list metrics request. |
value
|
array [Metric] |
The list of metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the metrics determined by the given filter for the given partition key range id.
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. |
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. |
Name | Data Type | Description |
---|---|---|
PartitionMetricListResult
|
The response to a list partition metrics request. |
value
|
array [PartitionMetric] |
The list of partition-level metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Metric
Metric data Properties
|
Retrieves the metrics determined by the given filter for the given collection, split by partition.
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. |
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. |
Name | Data Type | Description |
---|---|---|
PartitionMetricListResult
|
The response to a list partition metrics request. |
value
|
array [PartitionMetric] |
The list of partition-level metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Metric
Metric data Properties
|
Retrieves the usages (most recent storage data) for the given collection, split by partition.
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. |
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. |
Name | Data Type | Description |
---|---|---|
PartitionUsagesResult
|
The response to a list partition level usage request. |
value
|
array [PartitionUsage] |
The list of partition-level usages for the database. A usage is a point in time metric |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Usage
The usage data for a usage request. Properties
|
Retrieves the usages (most recent storage data) for the given collection.
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. |
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. |
Name | Data Type | Description |
---|---|---|
UsagesResult
|
The response to a list usage request. |
value
|
array [Usage] |
The list of usages for the database. A usage is a point in time metric |
|||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves metric definitions for the given database.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricDefinitionsListResult
|
The response to a list metric definitions request. |
value
|
array [MetricDefinition] |
The list of metric definitions for the account. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the metrics determined by the given filter for the given database account and database.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricListResult
|
The response to a list metrics request. |
value
|
array [Metric] |
The list of metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the usages (most recent data) for the given database.
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. |
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. |
Name | Data Type | Description |
---|---|---|
UsagesResult
|
The response to a list usage request. |
value
|
array [Usage] |
The list of usages for the database. A usage is a point in time metric |
|||||||||||||||||||||||||||||||||||||||
Properties
|
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.
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. |
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. |
Name | Data Type | Description |
---|---|---|
FailoverPolicies
|
The list of new failover policies for the failover priority change. |
failoverPolicies
|
array [FailoverPolicy] |
List of failover policies. |
|||||||||||||
Properties
|
Lists the connection strings for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountListConnectionStringsResult
|
The connection strings for the given database account. |
connectionStrings
|
array [DatabaseAccountConnectionString] |
An array that contains the connection strings for the Cosmos DB account. |
||||||||||
Properties
|
Lists the access keys for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountListKeysResult
|
The access keys for the given database account. |
secondaryMasterKey
|
string Read-only |
Base 64 encoded value of the secondary read-write key. |
||||||||||
properties
|
DatabaseAccountListReadOnlyKeysResult | |||||||||||
Properties
|
||||||||||||
primaryMasterKey
|
string Read-only |
Base 64 encoded value of the primary read-write key. |
Retrieves metric definitions for the given database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricDefinitionsListResult
|
The response to a list metric definitions request. |
value
|
array [MetricDefinition] |
The list of metric definitions for the account. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the metrics determined by the given filter for the given database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricListResult
|
The response to a list metrics request. |
value
|
array [Metric] |
The list of metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Offline the specified region for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
RegionForOnlineOffline
|
Cosmos DB region to online or offline. |
region
|
string |
Cosmos DB region, with spaces between words and each word capitalized. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error Response. |
message
|
string |
Error message indicating why the operation failed. |
code
|
string |
Error code. |
Online the specified region for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
RegionForOnlineOffline
|
Cosmos DB region to online or offline. |
region
|
string |
Cosmos DB region, with spaces between words and each word capitalized. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error Response. |
message
|
string |
Error message indicating why the operation failed. |
code
|
string |
Error code. |
Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
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. |
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. |
Name | Data Type | Description |
---|---|---|
PercentileMetricListResult
|
The response to a list percentile metrics request. |
value
|
array [PercentileMetric] |
The list of percentile metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Lists the read-only access keys for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountListReadOnlyKeysResult
|
The read-only access keys for the given database account. |
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. |
Lists the read-only access keys for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountListReadOnlyKeysResult
|
The read-only access keys for the given database account. |
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. |
Regenerates an access key for the specified Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountRegenerateKeyParameters
|
object |
Parameters to regenerate the keys within the database account. |
keyKind
|
string Allowed values: - primary - secondary - primaryReadonly - secondaryReadonly |
The access key to regenerate. |
Retrieves the metrics determined by the given filter for the given database account, collection and region.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricListResult
|
The response to a list metrics request. |
value
|
array [Metric] |
The list of metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the metrics determined by the given filter for the given partition key range id and region.
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. |
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. |
Name | Data Type | Description |
---|---|---|
PartitionMetricListResult
|
The response to a list partition metrics request. |
value
|
array [PartitionMetric] |
The list of partition-level metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Metric
Metric data Properties
|
Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
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. |
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. |
Name | Data Type | Description |
---|---|---|
PartitionMetricListResult
|
The response to a list partition metrics request. |
value
|
array [PartitionMetric] |
The list of partition-level metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Metric
Metric data Properties
|
Retrieves the metrics determined by the given filter for the given database account and region.
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. |
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. |
Name | Data Type | Description |
---|---|---|
MetricListResult
|
The response to a list metrics request. |
value
|
array [Metric] |
The list of metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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
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. |
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. |
Name | Data Type | Description |
---|---|---|
PercentileMetricListResult
|
The response to a list percentile metrics request. |
value
|
array [PercentileMetric] |
The list of percentile metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data
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. |
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. |
Name | Data Type | Description |
---|---|---|
PercentileMetricListResult
|
The response to a list percentile metrics request. |
value
|
array [PercentileMetric] |
The list of percentile metrics for the account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves the usages (most recent data) for the given database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
UsagesResult
|
The response to a list usage request. |
value
|
array [Usage] |
The list of usages for the database. A usage is a point in time metric |
|||||||||||||||||||||||||||||||||||||||
Properties
|
Deletes an existing Azure Cosmos DB database account.
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. |
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. |
Retrieves the properties of an existing Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccount
|
object |
An Azure Cosmos DB database account. |
type
|
string Read-only |
The type of Azure resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
Tags | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A database account resource.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
||||
tags
|
Tags | |||||
|
||||||
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. |
Patches the properties of an existing Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountPatchParameters
|
object |
Parameters for patching Azure Cosmos DB database account properties. |
tags
|
Tags | ||||||||||||||||||
|
|||||||||||||||||||
properties
|
DatabaseAccountPatchProperties | ||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DatabaseAccount
|
object |
An Azure Cosmos DB database account. |
type
|
string Read-only |
The type of Azure resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
Tags | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A database account resource.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
||||
tags
|
Tags | |||||
|
||||||
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. |
Creates or updates an Azure Cosmos DB database account.
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. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountCreateUpdateParameters
|
object |
Parameters to create and update Cosmos DB database accounts. |
type
|
string Read-only |
The type of Azure resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
Tags | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A database account resource.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
||||
tags
|
Tags | |||||
|
||||||
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccount
|
object |
An Azure Cosmos DB database account. |
type
|
string Read-only |
The type of Azure resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
Tags | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A database account resource.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
||||
tags
|
Tags | |||||
|
||||||
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. |
Lists all the Azure Cosmos DB database accounts available under the given resource group.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Azure subscription ID. |
resourceGroupName
|
string Pattern: ^[-\w\._\(\)]+$ Minimum: 1 Maximum: 90 |
Name of an Azure resource group. |
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. |
Name | Data Type | Description |
---|---|---|
DatabaseAccountsListResult
|
The List operation response, that contains the database accounts and their properties. |
value
|
array [DatabaseAccount] |
List of database account and their properties. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
A database account resource. Properties
|
Cosmos DB capability object
Name | Data Type | Description |
---|---|---|
name
|
string |
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". |
The consistency policy for the Cosmos DB database account.
Name | Data Type | Description |
---|---|---|
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. |
An Azure Cosmos DB database account.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
Tags | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A database account resource.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
||||
tags
|
Tags | |||||
|
||||||
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. |
Connection string for the Cosmos DB account
Name | Data Type | Description |
---|---|---|
description
|
string Read-only |
Description of the connection string |
connectionString
|
string Read-only |
Value of the connection string |
Parameters to create and update Cosmos DB database accounts.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
Tags | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A database account resource.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
type
|
string Read-only |
The type of Azure resource. |
||||
tags
|
Tags | |||||
|
||||||
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 to create and update Azure Cosmos DB database accounts.
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
virtualNetworkRules
|
array [VirtualNetworkRule] |
List of Virtual Network ACL rules configured for the Cosmos DB account. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
locations
|
array [Location] |
An array that contains the georeplication locations enabled for the Cosmos DB account. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||
databaseAccountOfferType
|
DatabaseAccountOfferType | |||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
consistencyPolicy
|
ConsistencyPolicy |
The consistency policy for the Cosmos DB account. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
capabilities
|
array [Capability] |
List of Cosmos DB capabilities for the account |
||||||||||||||||||||||||||
Properties
|
The connection strings for the given database account.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
connectionStrings
|
array [DatabaseAccountConnectionString] |
An array that contains the connection strings for the Cosmos DB account. |
||||||||||
Properties
|
The access keys for the given database account.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
secondaryMasterKey
|
string Read-only |
Base 64 encoded value of the secondary read-write key. |
||||||||||
properties
|
DatabaseAccountListReadOnlyKeysResult | |||||||||||
Properties
|
||||||||||||
primaryMasterKey
|
string Read-only |
Base 64 encoded value of the primary read-write key. |
The read-only access keys for the given database account.
Name | Data Type | Description |
---|---|---|
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. |
The offer type for the Cosmos DB database account.
Name | Data Type | Description |
---|---|---|
DatabaseAccountOfferType
|
string Allowed values: - Standard |
The offer type for the Cosmos DB database account. |
Parameters for patching Azure Cosmos DB database account properties.
Name | Data Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tags
|
Tags | ||||||||||||||||||
|
|||||||||||||||||||
properties
|
DatabaseAccountPatchProperties | ||||||||||||||||||
Properties
|
Properties to update Azure Cosmos DB database accounts.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
capabilities
|
array [Capability] |
List of Cosmos DB capabilities for the account |
|||||||
Properties
|
Properties for the database account.
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
writeLocations
|
array [Location] |
An array that contains the write location for the Cosmos DB account. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
virtualNetworkRules
|
array [VirtualNetworkRule] |
List of Virtual Network ACL rules configured for the Cosmos DB account. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
readLocations
|
array [Location] |
An array that contains of the read locations enabled for the Cosmos DB account. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
capabilities
|
array [Capability] |
List of Cosmos DB capabilities for the account |
||||||||||||||||||||||||||
Properties
|
Parameters to regenerate the keys within the database account.
Name | Data Type | Description |
---|---|---|
keyKind
|
string Allowed values: - primary - secondary - primaryReadonly - secondaryReadonly |
The access key to regenerate. |
The List operation response, that contains the database accounts and their properties.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [DatabaseAccount] |
List of database account and their properties. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
A database account resource. Properties
|
Error Response.
Name | Data Type | Description |
---|---|---|
message
|
string |
Error message indicating why the operation failed. |
code
|
string |
Error code. |
The list of new failover policies for the failover priority change.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
failoverPolicies
|
array [FailoverPolicy] |
List of failover policies. |
|||||||||||||
Properties
|
The failover policy for a given region of a database account.
Name | Data Type | Description |
---|---|---|
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. |
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.
Name | Data Type | Description |
---|---|---|
IPRangeFilter
|
string |
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. |
A region in which the Azure Cosmos DB database account is deployed.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
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/ |
Metric data
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
unit
|
UnitType |
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. |
||||||||||
Properties
|
||||||||||||
metricValues
|
array [MetricValue] |
The metric values for the specified time window and timestep. |
||||||||||
|