Microsoft.DocumentDB (stable:2020-04-01)

2025/10/23 • 126 new, 126 deleted methods

DatabaseAccounts_Get (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DatabaseAccounts_Update (new)
Description :  Updates the properties of an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateParameters:
{
Description: The parameters to provide for the current database account. ,
Required: True ,
}
{
tags:
{
Description: 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". ,
Required: False ,
}
object ,
location:
{
Description: The location of the resource group to which the resource belongs. ,
Required: False ,
}
string ,
properties:
{
Description: Properties to update Azure Cosmos DB database accounts. ,
Required: False ,
}
{
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
locations:
{
Description: An array that contains the georeplication locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. Currently, supported only for MongoDB API. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DatabaseAccounts_CreateOrUpdate (new)
Description :  Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateParameters:
{
Description: The parameters to provide for the current database account. ,
Required: True ,
}
{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties to create and update Azure Cosmos DB database accounts. ,
Required: True ,
}
{
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
locations:
{
Description: An array that contains the georeplication locations enabled for the Cosmos DB account. ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
databaseAccountOfferType:
{
Description: The offer type for the database ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. Currently, supported only for MongoDB API. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DatabaseAccounts_Delete (new)
Description :  Deletes an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DatabaseAccounts_FailoverPriorityChange (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
failoverParameters:
{
Description: The new failover policies for the database account. ,
Required: True ,
}
{
failoverPolicies:
{
Description: List of failover policies. ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DatabaseAccounts_List (new)
Description :  Lists all the Azure Cosmos DB database accounts available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of database account and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}
DatabaseAccounts_ListByResourceGroup (new)
Description :  Lists all the Azure Cosmos DB database accounts available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of database account and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}
DatabaseAccounts_ListKeys (new)
Description :  Lists the access keys for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryMasterKey:
{
Description: Base 64 encoded value of the primary read-write key. ,
Required: False ,
}
string ,
secondaryMasterKey:
{
Description: Base 64 encoded value of the secondary read-write key. ,
Required: False ,
}
string ,
}
DatabaseAccounts_ListConnectionStrings (new)
Description :  Lists the connection strings for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
connectionStrings:
{
Description: An array that contains the connection strings for the Cosmos DB account. ,
Required: False ,
}
[
{
connectionString:
{
Description: Value of the connection string ,
Required: False ,
}
string ,
description:
{
Description: Description of the connection string ,
Required: False ,
}
string ,
}
,
]
,
}
DatabaseAccounts_OfflineRegion (new)
Description :  Offline the specified region for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
regionParameterForOffline:
{
Description: Cosmos DB region to offline for the database account. ,
Required: True ,
}
{
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DatabaseAccounts_OnlineRegion (new)
Description :  Online the specified region for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
regionParameterForOnline:
{
Description: Cosmos DB region to online for the database account. ,
Required: True ,
}
{
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DatabaseAccounts_GetReadOnlyKeys (new)
Description :  Lists the read-only access keys for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the primary read-only key. ,
Required: False ,
}
string ,
secondaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the secondary read-only key. ,
Required: False ,
}
string ,
}
DatabaseAccounts_ListReadOnlyKeys (new)
Description :  Lists the read-only access keys for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the primary read-only key. ,
Required: False ,
}
string ,
secondaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the secondary read-only key. ,
Required: False ,
}
string ,
}
DatabaseAccounts_RegenerateKey (new)
Description :  Regenerates an access key for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
keyToRegenerate:
{
Description: The name of the key to regenerate. ,
Required: True ,
}
{
keyKind:
{
Description: The access key to regenerate. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
primaryReadonly: No description available. ,
secondaryReadonly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
DatabaseAccounts_CheckNameExists (new)
Description :  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.
Reference :  Link ¶

⚼ Request

HEAD:  /providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}
{
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
Operations_List (new)
Description :  Lists all of the available Cosmos DB Resource Provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DocumentDB/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Resource Provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
Provider:
{
Description: Service provider: Microsoft.ResourceProvider ,
Required: False ,
}
string ,
Resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
Operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
Description:
{
Description: Description of operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
DatabaseAccounts_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Database_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given database account and database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Collection_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given database account and collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
CollectionRegion_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given database account, collection and region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
DatabaseAccountRegion_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given database account and region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
PercentileSourceTarget_ListMetrics (new)
Description :  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
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
sourceRegion:
{
Description: Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of percentile metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The percentile metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
P10:
{
Description: The 10th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P25:
{
Description: The 25th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P50:
{
Description: The 50th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P75:
{
Description: The 75th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P90:
{
Description: The 90th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P95:
{
Description: The 95th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P99:
{
Description: The 99th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
PercentileTarget_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of percentile metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The percentile metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
P10:
{
Description: The 10th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P25:
{
Description: The 25th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P50:
{
Description: The 50th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P75:
{
Description: The 75th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P90:
{
Description: The 90th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P95:
{
Description: The 95th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P99:
{
Description: The 99th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Percentile_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of percentile metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The percentile metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
P10:
{
Description: The 10th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P25:
{
Description: The 25th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P50:
{
Description: The 50th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P75:
{
Description: The 75th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P90:
{
Description: The 90th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P95:
{
Description: The 95th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P99:
{
Description: The 99th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
CollectionPartitionRegion_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
CollectionPartition_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given collection, split by partition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
PartitionKeyRangeId_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given partition key range id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
partitionKeyRangeId:
{
Description: Partition Key Range Id for which to get data. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
PartitionKeyRangeIdRegion_ListMetrics (new)
Description :  Retrieves the metrics determined by the given filter for the given partition key range id and region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
partitionKeyRangeId:
{
Description: Partition Key Range Id for which to get data. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
DatabaseAccounts_ListUsages (new)
Description :  Retrieves the usages (most recent data) for the given database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
quotaPeriod:
{
Description: The quota period used to summarize the usage values. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: Current value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
Database_ListUsages (new)
Description :  Retrieves the usages (most recent data) for the given database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
quotaPeriod:
{
Description: The quota period used to summarize the usage values. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: Current value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
Collection_ListUsages (new)
Description :  Retrieves the usages (most recent storage data) for the given collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
quotaPeriod:
{
Description: The quota period used to summarize the usage values. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: Current value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
CollectionPartition_ListUsages (new)
Description :  Retrieves the usages (most recent storage data) for the given collection, split by partition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the usages. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the usages. ,
Required: False ,
}
string ,
}
,
]
,
}
Database_ListMetricDefinitions (new)
Description :  Retrieves metric definitions for the given database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions for the account. ,
Required: False ,
}
[
{
metricAvailabilities:
{
Description: The list of metric availabilities for the account. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
retention:
{
Description: The retention for the metric values. ,
Required: False ,
}
string ,
}
,
]
,
primaryAggregationType:
{
Description: The primary aggregation type of the metric. ,
Enum:
{
None: No description available. ,
Average: No description available. ,
Total: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Last: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri of the database. ,
Required: False ,
}
string ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Collection_ListMetricDefinitions (new)
Description :  Retrieves metric definitions for the given collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions for the account. ,
Required: False ,
}
[
{
metricAvailabilities:
{
Description: The list of metric availabilities for the account. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
retention:
{
Description: The retention for the metric values. ,
Required: False ,
}
string ,
}
,
]
,
primaryAggregationType:
{
Description: The primary aggregation type of the metric. ,
Enum:
{
None: No description available. ,
Average: No description available. ,
Total: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Last: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri of the database. ,
Required: False ,
}
string ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
DatabaseAccounts_ListMetricDefinitions (new)
Description :  Retrieves metric definitions for the given database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions for the account. ,
Required: False ,
}
[
{
metricAvailabilities:
{
Description: The list of metric availabilities for the account. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
retention:
{
Description: The retention for the metric values. ,
Required: False ,
}
string ,
}
,
]
,
primaryAggregationType:
{
Description: The primary aggregation type of the metric. ,
Enum:
{
None: No description available. ,
Average: No description available. ,
Total: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Last: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri of the database. ,
Required: False ,
}
string ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_ListSqlDatabases (new)
Description :  Lists the SQL databases under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SQL databases and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
{
_colls:
{
Description: A system generated property that specified the addressable path of the collections resource. ,
Required: False ,
}
string ,
_users:
{
Description: A system generated property that specifies the addressable path of the users resource. ,
Required: False ,
}
string ,
}
,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlDatabase (new)
Description :  Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
{
_colls:
{
Description: A system generated property that specified the addressable path of the collections resource. ,
Required: False ,
}
string ,
_users:
{
Description: A system generated property that specifies the addressable path of the users resource. ,
Required: False ,
}
string ,
}
,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlDatabase (new)
Description :  Create or update an Azure Cosmos DB SQL database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlDatabaseParameters:
{
Description: The parameters to provide for the current SQL database. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB SQL database. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a SQL database ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL database ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
{
_colls:
{
Description: A system generated property that specified the addressable path of the collections resource. ,
Required: False ,
}
string ,
_users:
{
Description: A system generated property that specifies the addressable path of the users resource. ,
Required: False ,
}
string ,
}
,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlDatabase (new)
Description :  Deletes an existing Azure Cosmos DB SQL database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_GetSqlDatabaseThroughput (new)
Description :  Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_UpdateSqlDatabaseThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB SQL database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The parameters to provide for the RUs per second of the current SQL database. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlDatabaseToAutoscale (new)
Description :  Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlDatabaseToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_ListSqlContainers (new)
Description :  Lists the SQL container under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of containers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB container ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlContainer (new)
Description :  Gets the SQL container under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB container ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlContainer (new)
Description :  Create or update an Azure Cosmos DB SQL container
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlContainerParameters:
{
Description: The parameters to provide for the current SQL container. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB container. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a container ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL container ,
Required: True ,
}
string ,
indexingPolicy:
{
Description: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container ,
Required: False ,
}
{
automatic:
{
Description: Indicates if the indexing policy is automatic ,
Required: False ,
}
boolean ,
indexingMode:
{
Description: Indicates the indexing mode. ,
Enum:
{
Consistent: No description available. ,
Lazy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
includedPaths:
{
Description: List of paths to include in the indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
indexes:
{
Description: List of indexes for this path ,
Required: False ,
}
[
{
dataType:
{
Description: The datatype for which the indexing behavior is applied to. ,
Enum:
{
String: No description available. ,
Number: No description available. ,
Point: No description available. ,
Polygon: No description available. ,
LineString: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: False ,
}
enum ,
precision:
{
Description: The precision of the index. -1 is maximum precision. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates the type of index. ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
Spatial: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
excludedPaths:
{
Description: List of paths to exclude from indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
}
,
]
,
compositeIndexes:
{
Description: List of composite path list ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
order:
{
Description: Sort order for composite paths. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
spatialIndexes:
{
Description: List of spatial specifics ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
types:
{
Description: List of path's spatial type ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
partitionKey:
{
Description: The configuration of the partition key to be used for partitioning data into multiple partitions ,
Required: False ,
}
{
paths:
{
Description: List of paths using which data within the container can be partitioned ,
Required: False ,
}
[
string ,
]
,
kind:
{
Description: Indicates the kind of algorithm used for partitioning ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Indicates the version of the partition key definition ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultTtl:
{
Description: Default time to live ,
Required: False ,
}
integer ,
uniqueKeyPolicy:
{
Description: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
{
uniqueKeys:
{
Description: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
[
{
paths:
{
Description: List of paths must be unique for each document in the Azure Cosmos DB service ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
conflictResolutionPolicy:
{
Description: The conflict resolution policy for the container. ,
Required: False ,
}
{
mode:
{
Description: Indicates the conflict resolution mode. ,
Enum:
{
LastWriterWins: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
conflictResolutionPath:
{
Description: The conflict resolution path in the case of LastWriterWins mode. ,
Required: False ,
}
string ,
conflictResolutionProcedure:
{
Description: The procedure to resolve conflicts in the case of custom mode. ,
Required: False ,
}
string ,
}
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB container ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlContainer (new)
Description :  Deletes an existing Azure Cosmos DB SQL container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_GetSqlContainerThroughput (new)
Description :  Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_UpdateSqlContainerThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB SQL container
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The parameters to provide for the RUs per second of the current SQL container. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlContainerToAutoscale (new)
Description :  Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlContainerToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_ListSqlStoredProcedures (new)
Description :  Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of storedProcedures and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB storedProcedure ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlStoredProcedure (new)
Description :  Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
storedProcedureName:
{
Description: Cosmos DB storedProcedure name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB storedProcedure ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlStoredProcedure (new)
Description :  Create or update an Azure Cosmos DB SQL storedProcedure
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
storedProcedureName:
{
Description: Cosmos DB storedProcedure name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlStoredProcedureParameters:
{
Description: The parameters to provide for the current SQL storedProcedure. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB storedProcedure. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a storedProcedure ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL storedProcedure ,
Required: True ,
}
string ,
body:
{
Description: Body of the Stored Procedure ,
Required: False ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB storedProcedure ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlStoredProcedure (new)
Description :  Deletes an existing Azure Cosmos DB SQL storedProcedure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
storedProcedureName:
{
Description: Cosmos DB storedProcedure name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_ListSqlUserDefinedFunctions (new)
Description :  Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of userDefinedFunctions and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB userDefinedFunction ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlUserDefinedFunction (new)
Description :  Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
userDefinedFunctionName:
{
Description: Cosmos DB userDefinedFunction name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB userDefinedFunction ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlUserDefinedFunction (new)
Description :  Create or update an Azure Cosmos DB SQL userDefinedFunction
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
userDefinedFunctionName:
{
Description: Cosmos DB userDefinedFunction name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlUserDefinedFunctionParameters:
{
Description: The parameters to provide for the current SQL userDefinedFunction. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB userDefinedFunction. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a userDefinedFunction ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL userDefinedFunction ,
Required: True ,
}
string ,
body:
{
Description: Body of the User Defined Function ,
Required: False ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB userDefinedFunction ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlUserDefinedFunction (new)
Description :  Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
userDefinedFunctionName:
{
Description: Cosmos DB userDefinedFunction name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_ListSqlTriggers (new)
Description :  Lists the SQL trigger under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of triggers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB trigger ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlTrigger (new)
Description :  Gets the SQL trigger under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
triggerName:
{
Description: Cosmos DB trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB trigger ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlTrigger (new)
Description :  Create or update an Azure Cosmos DB SQL trigger
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
triggerName:
{
Description: Cosmos DB trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlTriggerParameters:
{
Description: The parameters to provide for the current SQL trigger. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB trigger. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a trigger ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL trigger ,
Required: True ,
}
string ,
body:
{
Description: Body of the Trigger ,
Required: False ,
}
string ,
triggerType:
{
Description: Type of the Trigger ,
Enum:
{
Pre: No description available. ,
Post: No description available. ,
}
,
Required: False ,
}
enum ,
triggerOperation:
{
Description: The operation the trigger is associated with ,
Enum:
{
All: No description available. ,
Create: No description available. ,
Update: No description available. ,
Delete: No description available. ,
Replace: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB trigger ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlTrigger (new)
Description :  Deletes an existing Azure Cosmos DB SQL trigger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
triggerName:
{
Description: Cosmos DB trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
MongoDBResources_ListMongoDBDatabases (new)
Description :  Lists the MongoDB databases under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of MongoDB databases and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
MongoDBResources_GetMongoDBDatabase (new)
Description :  Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_CreateUpdateMongoDBDatabase (new)
Description :  Create or updates Azure Cosmos DB MongoDB database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateMongoDBDatabaseParameters:
{
Description: The parameters to provide for the current MongoDB database. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB MongoDB database. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a MongoDB database ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB MongoDB database ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_DeleteMongoDBDatabase (new)
Description :  Deletes an existing Azure Cosmos DB MongoDB database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
MongoDBResources_GetMongoDBDatabaseThroughput (new)
Description :  Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_UpdateMongoDBDatabaseThroughput (new)
Description :  Update RUs per second of the an Azure Cosmos DB MongoDB database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current MongoDB database. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBDatabaseToAutoscale (new)
Description :  Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBDatabaseToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_ListMongoDBCollections (new)
Description :  Lists the MongoDB collection under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of MongoDB collections and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB collection ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
MongoDBResources_GetMongoDBCollection (new)
Description :  Gets the MongoDB collection under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB collection ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_CreateUpdateMongoDBCollection (new)
Description :  Create or update an Azure Cosmos DB MongoDB Collection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateMongoDBCollectionParameters:
{
Description: The parameters to provide for the current MongoDB Collection. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB MongoDB collection. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a MongoDB collection ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB MongoDB collection ,
Required: True ,
}
string ,
shardKey:
{
Description: A key-value pair of shard keys to be applied for the request. ,
Required: False ,
}
object ,
indexes:
{
Description: List of index keys ,
Required: False ,
}
[
{
key:
{
Description: Cosmos DB MongoDB collection index keys ,
Required: False ,
}
{
keys:
{
Description: List of keys for each MongoDB collection in the Azure Cosmos DB service ,
Required: False ,
}
[
string ,
]
,
}
,
options:
{
Description: Cosmos DB MongoDB collection index key options ,
Required: False ,
}
{
expireAfterSeconds:
{
Description: Expire after seconds ,
Required: False ,
}
integer ,
unique:
{
Description: Is unique or not ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Required: False ,
}
integer ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB collection ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_DeleteMongoDBCollection (new)
Description :  Deletes an existing Azure Cosmos DB MongoDB Collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
MongoDBResources_GetMongoDBCollectionThroughput (new)
Description :  Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_UpdateMongoDBCollectionThroughput (new)
Description :  Update the RUs per second of an Azure Cosmos DB MongoDB collection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current MongoDB collection. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBCollectionToAutoscale (new)
Description :  Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBCollectionToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_ListTables (new)
Description :  Lists the Tables under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Table and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
TableResources_GetTable (new)
Description :  Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
TableResources_CreateUpdateTable (new)
Description :  Create or update an Azure Cosmos DB Table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateTableParameters:
{
Description: The parameters to provide for the current Table. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Table. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Table ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB table ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
TableResources_DeleteTable (new)
Description :  Deletes an existing Azure Cosmos DB Table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
TableResources_GetTableThroughput (new)
Description :  Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_UpdateTableThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB Table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The parameters to provide for the RUs per second of the current Table. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_MigrateTableToAutoscale (new)
Description :  Migrate an Azure Cosmos DB Table from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_MigrateTableToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB Table from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_ListCassandraKeyspaces (new)
Description :  Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Cassandra keyspaces and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra keyspace ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraKeyspace (new)
Description :  Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra keyspace ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_CreateUpdateCassandraKeyspace (new)
Description :  Create or update an Azure Cosmos DB Cassandra keyspace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraKeyspaceParameters:
{
Description: The parameters to provide for the current Cassandra keyspace. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Cassandra keyspace. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Cassandra keyspace ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Cassandra keyspace ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra keyspace ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_DeleteCassandraKeyspace (new)
Description :  Deletes an existing Azure Cosmos DB Cassandra keyspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
CassandraResources_GetCassandraKeyspaceThroughput (new)
Description :  Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_UpdateCassandraKeyspaceThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB Cassandra Keyspace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Cassandra Keyspace. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraKeyspaceToAutoscale (new)
Description :  Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraKeyspaceToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_ListCassandraTables (new)
Description :  Lists the Cassandra table under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Cassandra tables and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraTable (new)
Description :  Gets the Cassandra table under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_CreateUpdateCassandraTable (new)
Description :  Create or update an Azure Cosmos DB Cassandra Table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraTableParameters:
{
Description: The parameters to provide for the current Cassandra Table. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Cassandra table. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Cassandra table ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Cassandra table ,
Required: True ,
}
string ,
defaultTtl:
{
Description: Time to live of the Cosmos DB Cassandra table ,
Required: False ,
}
integer ,
schema:
{
Description: Schema of the Cosmos DB Cassandra table ,
Required: False ,
}
{
columns:
{
Description: List of Cassandra table columns. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB Cassandra table column ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cosmos DB Cassandra table column ,
Required: False ,
}
string ,
}
,
]
,
partitionKeys:
{
Description: List of partition key. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB Cassandra table partition key ,
Required: False ,
}
string ,
}
,
]
,
clusterKeys:
{
Description: List of cluster key. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB Cassandra table cluster key ,
Required: False ,
}
string ,
orderBy:
{
Description: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Required: False ,
}
integer ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_DeleteCassandraTable (new)
Description :  Deletes an existing Azure Cosmos DB Cassandra table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
CassandraResources_GetCassandraTableThroughput (new)
Description :  Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_UpdateCassandraTableThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB Cassandra table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Cassandra table. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraTableToAutoscale (new)
Description :  Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraTableToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_ListGremlinDatabases (new)
Description :  Lists the Gremlin databases under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Gremlin databases and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GremlinResources_GetGremlinDatabase (new)
Description :  Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_CreateUpdateGremlinDatabase (new)
Description :  Create or update an Azure Cosmos DB Gremlin database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGremlinDatabaseParameters:
{
Description: The parameters to provide for the current Gremlin database. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Gremlin database. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Gremlin database ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Gremlin database ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_DeleteGremlinDatabase (new)
Description :  Deletes an existing Azure Cosmos DB Gremlin database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
GremlinResources_GetGremlinDatabaseThroughput (new)
Description :  Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_UpdateGremlinDatabaseThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB Gremlin database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Gremlin database. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinDatabaseToAutoscale (new)
Description :  Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinDatabaseToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_ListGremlinGraphs (new)
Description :  Lists the Gremlin graph under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of graphs and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Gremlin graph ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GremlinResources_GetGremlinGraph (new)
Description :  Gets the Gremlin graph under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Gremlin graph ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_CreateUpdateGremlinGraph (new)
Description :  Create or update an Azure Cosmos DB Gremlin graph
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGremlinGraphParameters:
{
Description: The parameters to provide for the current Gremlin graph. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Gremlin graph. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Gremlin graph ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Gremlin graph ,
Required: True ,
}
string ,
indexingPolicy:
{
Description: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph ,
Required: False ,
}
{
automatic:
{
Description: Indicates if the indexing policy is automatic ,
Required: False ,
}
boolean ,
indexingMode:
{
Description: Indicates the indexing mode. ,
Enum:
{
Consistent: No description available. ,
Lazy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
includedPaths:
{
Description: List of paths to include in the indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
indexes:
{
Description: List of indexes for this path ,
Required: False ,
}
[
{
dataType:
{
Description: The datatype for which the indexing behavior is applied to. ,
Enum:
{
String: No description available. ,
Number: No description available. ,
Point: No description available. ,
Polygon: No description available. ,
LineString: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: False ,
}
enum ,
precision:
{
Description: The precision of the index. -1 is maximum precision. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates the type of index. ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
Spatial: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
excludedPaths:
{
Description: List of paths to exclude from indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
}
,
]
,
compositeIndexes:
{
Description: List of composite path list ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
order:
{
Description: Sort order for composite paths. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
spatialIndexes:
{
Description: List of spatial specifics ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
types:
{
Description: List of path's spatial type ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
partitionKey:
{
Description: The configuration of the partition key to be used for partitioning data into multiple partitions ,
Required: False ,
}
{
paths:
{
Description: List of paths using which data within the container can be partitioned ,
Required: False ,
}
[
string ,
]
,
kind:
{
Description: Indicates the kind of algorithm used for partitioning ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Indicates the version of the partition key definition ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultTtl:
{
Description: Default time to live ,
Required: False ,
}
integer ,
uniqueKeyPolicy:
{
Description: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
{
uniqueKeys:
{
Description: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
[
{
paths:
{
Description: List of paths must be unique for each document in the Azure Cosmos DB service ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
conflictResolutionPolicy:
{
Description: The conflict resolution policy for the graph. ,
Required: False ,
}
{
mode:
{
Description: Indicates the conflict resolution mode. ,
Enum:
{
LastWriterWins: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
conflictResolutionPath:
{
Description: The conflict resolution path in the case of LastWriterWins mode. ,
Required: False ,
}
string ,
conflictResolutionProcedure:
{
Description: The procedure to resolve conflicts in the case of custom mode. ,
Required: False ,
}
string ,
}
,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Gremlin graph ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_DeleteGremlinGraph (new)
Description :  Deletes an existing Azure Cosmos DB Gremlin graph.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
GremlinResources_GetGremlinGraphThroughput (new)
Description :  Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_UpdateGremlinGraphThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB Gremlin graph
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Gremlin graph. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinGraphToAutoscale (new)
Description :  Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinGraphToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
NotebookWorkspaces_ListByDatabaseAccount (new)
Description :  Gets the notebook workspace resources of an existing Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of notebook workspace resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
status:
{
Description: Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_Get (new)
Description :  Gets the notebook workspace for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
status:
{
Description: Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_CreateOrUpdate (new)
Description :  Creates the notebook workspace for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
notebookCreateUpdateParameters:
{
Description: The notebook workspace to create for the current database account. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
status:
{
Description: Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_Delete (new)
Description :  Deletes the notebook workspace for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_ListConnectionInfo (new)
Description :  Retrieves the connection info for the notebook workspace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/listConnectionInfo
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authToken:
{
Description: Specifies auth token used for connecting to Notebook server (uses token-based auth). ,
Required: False ,
}
string ,
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_RegenerateAuthToken (new)
Description :  Regenerates the auth token for the notebook workspace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/regenerateAuthToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_Start (new)
Description :  Starts the notebook workspace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/start
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DatabaseAccounts_Get (removed)
Description :  Retrieves the properties of an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DatabaseAccounts_Update (removed)
Description :  Updates the properties of an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateParameters:
{
Description: The parameters to provide for the current database account. ,
Required: True ,
}
{
tags:
{
Description: 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". ,
Required: False ,
}
object ,
location:
{
Description: The location of the resource group to which the resource belongs. ,
Required: False ,
}
string ,
properties:
{
Description: Properties to update Azure Cosmos DB database accounts. ,
Required: False ,
}
{
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
locations:
{
Description: An array that contains the georeplication locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. Currently, supported only for MongoDB API. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DatabaseAccounts_CreateOrUpdate (removed)
Description :  Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateParameters:
{
Description: The parameters to provide for the current database account. ,
Required: True ,
}
{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties to create and update Azure Cosmos DB database accounts. ,
Required: True ,
}
{
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
locations:
{
Description: An array that contains the georeplication locations enabled for the Cosmos DB account. ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
databaseAccountOfferType:
{
Description: The offer type for the database ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. Currently, supported only for MongoDB API. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DatabaseAccounts_Delete (removed)
Description :  Deletes an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DatabaseAccounts_FailoverPriorityChange (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
failoverParameters:
{
Description: The new failover policies for the database account. ,
Required: True ,
}
{
failoverPolicies:
{
Description: List of failover policies. ,
Required: True ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DatabaseAccounts_List (removed)
Description :  Lists all the Azure Cosmos DB database accounts available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of database account and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}
DatabaseAccounts_ListByResourceGroup (removed)
Description :  Lists all the Azure Cosmos DB database accounts available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of database account and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: Indicates the type of database account. This can only be set at database account creation. ,
Enum:
{
GlobalDocumentDB: No description available. ,
MongoDB: No description available. ,
Parse: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties for the database account. ,
Required: False ,
}
{
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the Cosmos DB database account. ,
Required: False ,
}
string ,
databaseAccountOfferType:
{
Description: The offer type for the Cosmos DB database account. Default value: Standard. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules. ,
Required: False ,
}
[
{
ipAddressOrRange:
{
Description: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. ,
Required: False ,
}
string ,
}
,
]
,
isVirtualNetworkFilterEnabled:
{
Description: Flag to indicate whether to enable/disable Virtual Network ACL rules. ,
Required: False ,
}
boolean ,
enableAutomaticFailover:
{
Description: 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. ,
Required: False ,
}
boolean ,
consistencyPolicy:
{
Description: The consistency policy for the Cosmos DB database account. ,
Required: False ,
}
{
defaultConsistencyLevel:
{
Description: The default consistency level and configuration settings of the Cosmos DB account. ,
Enum:
{
Eventual: No description available. ,
Session: No description available. ,
BoundedStaleness: No description available. ,
Strong: No description available. ,
ConsistentPrefix: No description available. ,
}
,
Required: True ,
}
enum ,
maxStalenessPrefix:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInSeconds:
{
Description: 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'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capabilities:
{
Description: List of Cosmos DB capabilities for the account ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ,
Required: False ,
}
string ,
}
,
]
,
writeLocations:
{
Description: An array that contains the write location for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
readLocations:
{
Description: An array that contains of the read locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
locations:
{
Description: An array that contains all of the locations enabled for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
documentEndpoint:
{
Description: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ ,
Required: False ,
}
string ,
provisioningState:
{
Description: 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
isZoneRedundant:
{
Description: Flag to indicate whether or not this region is an AvailabilityZone region ,
Required: False ,
}
boolean ,
}
,
]
,
failoverPolicies:
{
Description: An array that contains the regions ordered by their failover priorities. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. ,
Required: False ,
}
string ,
locationName:
{
Description: The name of the region in which the database account exists. ,
Required: False ,
}
string ,
failoverPriority:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
virtualNetworkRules:
{
Description: List of Virtual Network ACL rules configured for the Cosmos DB account. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ,
Required: False ,
}
string ,
ignoreMissingVNetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the Cosmos DB account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
enableMultipleWriteLocations:
{
Description: Enables the account to write in multiple locations ,
Required: False ,
}
boolean ,
enableCassandraConnector:
{
Description: Enables the cassandra connector on the Cosmos DB C* account ,
Required: False ,
}
boolean ,
connectorOffer:
{
Description: The cassandra connector offer type for the Cosmos DB database C* account. ,
Enum:
{
Small: No description available. ,
}
,
Required: False ,
}
enum ,
disableKeyBasedMetadataWriteAccess:
{
Description: Disable write operations on metadata resources (databases, containers, throughput) via account keys ,
Required: False ,
}
boolean ,
keyVaultKeyUri:
{
Description: The URI of the key vault ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enableFreeTier:
{
Description: Flag to indicate whether Free Tier is enabled. ,
Required: False ,
}
boolean ,
apiProperties:
{
Description: API specific properties. ,
Required: False ,
}
{
serverVersion:
{
Description: Describes the ServerVersion of an a MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
cors:
{
Description: The CORS policy for the Cosmos DB database account. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: The origin domains that are permitted to make a request against the service via CORS. ,
Required: True ,
}
string ,
allowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. ,
Required: False ,
}
string ,
allowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: False ,
}
string ,
exposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: False ,
}
string ,
maxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}
DatabaseAccounts_ListKeys (removed)
Description :  Lists the access keys for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryMasterKey:
{
Description: Base 64 encoded value of the primary read-write key. ,
Required: False ,
}
string ,
secondaryMasterKey:
{
Description: Base 64 encoded value of the secondary read-write key. ,
Required: False ,
}
string ,
}
DatabaseAccounts_ListConnectionStrings (removed)
Description :  Lists the connection strings for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
connectionStrings:
{
Description: An array that contains the connection strings for the Cosmos DB account. ,
Required: False ,
}
[
{
connectionString:
{
Description: Value of the connection string ,
Required: False ,
}
string ,
description:
{
Description: Description of the connection string ,
Required: False ,
}
string ,
}
,
]
,
}
DatabaseAccounts_OfflineRegion (removed)
Description :  Offline the specified region for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
regionParameterForOffline:
{
Description: Cosmos DB region to offline for the database account. ,
Required: True ,
}
{
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DatabaseAccounts_OnlineRegion (removed)
Description :  Online the specified region for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
regionParameterForOnline:
{
Description: Cosmos DB region to online for the database account. ,
Required: True ,
}
{
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DatabaseAccounts_GetReadOnlyKeys (removed)
Description :  Lists the read-only access keys for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the primary read-only key. ,
Required: False ,
}
string ,
secondaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the secondary read-only key. ,
Required: False ,
}
string ,
}
DatabaseAccounts_ListReadOnlyKeys (removed)
Description :  Lists the read-only access keys for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the primary read-only key. ,
Required: False ,
}
string ,
secondaryReadonlyMasterKey:
{
Description: Base 64 encoded value of the secondary read-only key. ,
Required: False ,
}
string ,
}
DatabaseAccounts_RegenerateKey (removed)
Description :  Regenerates an access key for the specified Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
keyToRegenerate:
{
Description: The name of the key to regenerate. ,
Required: True ,
}
{
keyKind:
{
Description: The access key to regenerate. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
primaryReadonly: No description available. ,
secondaryReadonly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
DatabaseAccounts_CheckNameExists (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

HEAD:  /providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}
{
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
Operations_List (removed)
Description :  Lists all of the available Cosmos DB Resource Provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DocumentDB/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Resource Provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
Provider:
{
Description: Service provider: Microsoft.ResourceProvider ,
Required: False ,
}
string ,
Resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
Operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
Description:
{
Description: Description of operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
DatabaseAccounts_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Database_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given database account and database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Collection_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given database account and collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
CollectionRegion_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given database account, collection and region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
DatabaseAccountRegion_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given database account and region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
_count:
{
Description: The number of values for the metric. ,
Format: int32 ,
Required: False ,
}
number ,
average:
{
Description: The average value of the metric. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The max value of the metric. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The min value of the metric. ,
Format: double ,
Required: False ,
}
number ,
timestamp:
{
Description: The metric timestamp (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
total:
{
Description: The total value of the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
PercentileSourceTarget_ListMetrics (removed)
Description :  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
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
sourceRegion:
{
Description: Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of percentile metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The percentile metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
P10:
{
Description: The 10th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P25:
{
Description: The 25th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P50:
{
Description: The 50th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P75:
{
Description: The 75th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P90:
{
Description: The 90th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P95:
{
Description: The 95th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P99:
{
Description: The 99th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
PercentileTarget_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of percentile metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The percentile metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
P10:
{
Description: The 10th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P25:
{
Description: The 25th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P50:
{
Description: The 50th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P75:
{
Description: The 75th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P90:
{
Description: The 90th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P95:
{
Description: The 95th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P99:
{
Description: The 99th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
Percentile_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of percentile metrics for the account. ,
Required: False ,
}
[
{
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
metricValues:
{
Description: The percentile metric values for the specified time window and timestep. ,
Required: False ,
}
[
{
P10:
{
Description: The 10th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P25:
{
Description: The 25th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P50:
{
Description: The 50th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P75:
{
Description: The 75th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P90:
{
Description: The 90th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P95:
{
Description: The 95th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
P99:
{
Description: The 99th percentile value for the metric. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
CollectionPartitionRegion_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
CollectionPartition_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given collection, split by partition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
PartitionKeyRangeId_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given partition key range id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
partitionKeyRangeId:
{
Description: Partition Key Range Id for which to get data. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
PartitionKeyRangeIdRegion_ListMetrics (removed)
Description :  Retrieves the metrics determined by the given filter for the given partition key range id and region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
region:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
partitionKeyRangeId:
{
Description: Partition Key Range Id for which to get data. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level metrics for the account. ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the metric values. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the metric values. ,
Required: False ,
}
string ,
}
,
]
,
}
DatabaseAccounts_ListUsages (removed)
Description :  Retrieves the usages (most recent data) for the given database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
quotaPeriod:
{
Description: The quota period used to summarize the usage values. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: Current value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
Database_ListUsages (removed)
Description :  Retrieves the usages (most recent data) for the given database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
quotaPeriod:
{
Description: The quota period used to summarize the usage values. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: Current value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
Collection_ListUsages (removed)
Description :  Retrieves the usages (most recent storage data) for the given collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
quotaPeriod:
{
Description: The quota period used to summarize the usage values. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: Current value for this metric ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
CollectionPartition_ListUsages (removed)
Description :  Retrieves the usages (most recent storage data) for the given collection, split by partition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: 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). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of partition-level usages for the database. A usage is a point in time metric ,
Required: False ,
}
[
{
partitionId:
{
Description: The partition id (GUID identifier) of the usages. ,
Required: False ,
}
string ,
partitionKeyRangeId:
{
Description: The partition key range id (integer identifier) of the usages. ,
Required: False ,
}
string ,
}
,
]
,
}
Database_ListMetricDefinitions (removed)
Description :  Retrieves metric definitions for the given database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions for the account. ,
Required: False ,
}
[
{
metricAvailabilities:
{
Description: The list of metric availabilities for the account. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
retention:
{
Description: The retention for the metric values. ,
Required: False ,
}
string ,
}
,
]
,
primaryAggregationType:
{
Description: The primary aggregation type of the metric. ,
Enum:
{
None: No description available. ,
Average: No description available. ,
Total: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Last: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri of the database. ,
Required: False ,
}
string ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Collection_ListMetricDefinitions (removed)
Description :  Retrieves metric definitions for the given collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseRid:
{
Description: Cosmos DB database rid. ,
Required: True ,
}
string ,
collectionRid:
{
Description: Cosmos DB collection rid. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions for the account. ,
Required: False ,
}
[
{
metricAvailabilities:
{
Description: The list of metric availabilities for the account. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
retention:
{
Description: The retention for the metric values. ,
Required: False ,
}
string ,
}
,
]
,
primaryAggregationType:
{
Description: The primary aggregation type of the metric. ,
Enum:
{
None: No description available. ,
Average: No description available. ,
Total: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Last: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri of the database. ,
Required: False ,
}
string ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
DatabaseAccounts_ListMetricDefinitions (removed)
Description :  Retrieves metric definitions for the given database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metric definitions for the account. ,
Required: False ,
}
[
{
metricAvailabilities:
{
Description: The list of metric availabilities for the account. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain to be used to summarize the metric values. ,
Required: False ,
}
string ,
retention:
{
Description: The retention for the metric values. ,
Required: False ,
}
string ,
}
,
]
,
primaryAggregationType:
{
Description: The primary aggregation type of the metric. ,
Enum:
{
None: No description available. ,
Average: No description available. ,
Total: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Last: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Milliseconds: No description available. ,
}
,
Required: False ,
}
enum ,
resourceUri:
{
Description: The resource uri of the database. ,
Required: False ,
}
string ,
name:
{
Description: The name information for the metric. ,
Required: False ,
}
{
value:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The friendly name of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_ListSqlDatabases (removed)
Description :  Lists the SQL databases under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SQL databases and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
{
_colls:
{
Description: A system generated property that specified the addressable path of the collections resource. ,
Required: False ,
}
string ,
_users:
{
Description: A system generated property that specifies the addressable path of the users resource. ,
Required: False ,
}
string ,
}
,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlDatabase (removed)
Description :  Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
{
_colls:
{
Description: A system generated property that specified the addressable path of the collections resource. ,
Required: False ,
}
string ,
_users:
{
Description: A system generated property that specifies the addressable path of the users resource. ,
Required: False ,
}
string ,
}
,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlDatabase (removed)
Description :  Create or update an Azure Cosmos DB SQL database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlDatabaseParameters:
{
Description: The parameters to provide for the current SQL database. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB SQL database. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a SQL database ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL database ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
{
_colls:
{
Description: A system generated property that specified the addressable path of the collections resource. ,
Required: False ,
}
string ,
_users:
{
Description: A system generated property that specifies the addressable path of the users resource. ,
Required: False ,
}
string ,
}
,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlDatabase (removed)
Description :  Deletes an existing Azure Cosmos DB SQL database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_GetSqlDatabaseThroughput (removed)
Description :  Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_UpdateSqlDatabaseThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB SQL database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The parameters to provide for the RUs per second of the current SQL database. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlDatabaseToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlDatabaseToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_ListSqlContainers (removed)
Description :  Lists the SQL container under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of containers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB container ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlContainer (removed)
Description :  Gets the SQL container under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB container ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlContainer (removed)
Description :  Create or update an Azure Cosmos DB SQL container
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlContainerParameters:
{
Description: The parameters to provide for the current SQL container. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB container. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a container ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL container ,
Required: True ,
}
string ,
indexingPolicy:
{
Description: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container ,
Required: False ,
}
{
automatic:
{
Description: Indicates if the indexing policy is automatic ,
Required: False ,
}
boolean ,
indexingMode:
{
Description: Indicates the indexing mode. ,
Enum:
{
Consistent: No description available. ,
Lazy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
includedPaths:
{
Description: List of paths to include in the indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
indexes:
{
Description: List of indexes for this path ,
Required: False ,
}
[
{
dataType:
{
Description: The datatype for which the indexing behavior is applied to. ,
Enum:
{
String: No description available. ,
Number: No description available. ,
Point: No description available. ,
Polygon: No description available. ,
LineString: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: False ,
}
enum ,
precision:
{
Description: The precision of the index. -1 is maximum precision. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates the type of index. ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
Spatial: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
excludedPaths:
{
Description: List of paths to exclude from indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
}
,
]
,
compositeIndexes:
{
Description: List of composite path list ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
order:
{
Description: Sort order for composite paths. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
spatialIndexes:
{
Description: List of spatial specifics ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
types:
{
Description: List of path's spatial type ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
partitionKey:
{
Description: The configuration of the partition key to be used for partitioning data into multiple partitions ,
Required: False ,
}
{
paths:
{
Description: List of paths using which data within the container can be partitioned ,
Required: False ,
}
[
string ,
]
,
kind:
{
Description: Indicates the kind of algorithm used for partitioning ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Indicates the version of the partition key definition ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultTtl:
{
Description: Default time to live ,
Required: False ,
}
integer ,
uniqueKeyPolicy:
{
Description: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
{
uniqueKeys:
{
Description: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
[
{
paths:
{
Description: List of paths must be unique for each document in the Azure Cosmos DB service ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
conflictResolutionPolicy:
{
Description: The conflict resolution policy for the container. ,
Required: False ,
}
{
mode:
{
Description: Indicates the conflict resolution mode. ,
Enum:
{
LastWriterWins: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
conflictResolutionPath:
{
Description: The conflict resolution path in the case of LastWriterWins mode. ,
Required: False ,
}
string ,
conflictResolutionProcedure:
{
Description: The procedure to resolve conflicts in the case of custom mode. ,
Required: False ,
}
string ,
}
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB container ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlContainer (removed)
Description :  Deletes an existing Azure Cosmos DB SQL container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_GetSqlContainerThroughput (removed)
Description :  Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_UpdateSqlContainerThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB SQL container
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The parameters to provide for the RUs per second of the current SQL container. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlContainerToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_MigrateSqlContainerToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_ListSqlStoredProcedures (removed)
Description :  Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of storedProcedures and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB storedProcedure ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlStoredProcedure (removed)
Description :  Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
storedProcedureName:
{
Description: Cosmos DB storedProcedure name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB storedProcedure ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlStoredProcedure (removed)
Description :  Create or update an Azure Cosmos DB SQL storedProcedure
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
storedProcedureName:
{
Description: Cosmos DB storedProcedure name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlStoredProcedureParameters:
{
Description: The parameters to provide for the current SQL storedProcedure. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB storedProcedure. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a storedProcedure ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL storedProcedure ,
Required: True ,
}
string ,
body:
{
Description: Body of the Stored Procedure ,
Required: False ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB storedProcedure ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlStoredProcedure (removed)
Description :  Deletes an existing Azure Cosmos DB SQL storedProcedure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
storedProcedureName:
{
Description: Cosmos DB storedProcedure name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_ListSqlUserDefinedFunctions (removed)
Description :  Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of userDefinedFunctions and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB userDefinedFunction ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlUserDefinedFunction (removed)
Description :  Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
userDefinedFunctionName:
{
Description: Cosmos DB userDefinedFunction name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB userDefinedFunction ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlUserDefinedFunction (removed)
Description :  Create or update an Azure Cosmos DB SQL userDefinedFunction
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
userDefinedFunctionName:
{
Description: Cosmos DB userDefinedFunction name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlUserDefinedFunctionParameters:
{
Description: The parameters to provide for the current SQL userDefinedFunction. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB userDefinedFunction. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a userDefinedFunction ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL userDefinedFunction ,
Required: True ,
}
string ,
body:
{
Description: Body of the User Defined Function ,
Required: False ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB userDefinedFunction ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlUserDefinedFunction (removed)
Description :  Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
userDefinedFunctionName:
{
Description: Cosmos DB userDefinedFunction name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
SqlResources_ListSqlTriggers (removed)
Description :  Lists the SQL trigger under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of triggers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB trigger ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetSqlTrigger (removed)
Description :  Gets the SQL trigger under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
triggerName:
{
Description: Cosmos DB trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB trigger ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateSqlTrigger (removed)
Description :  Create or update an Azure Cosmos DB SQL trigger
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
triggerName:
{
Description: Cosmos DB trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateSqlTriggerParameters:
{
Description: The parameters to provide for the current SQL trigger. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB trigger. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a trigger ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB SQL trigger ,
Required: True ,
}
string ,
body:
{
Description: Body of the Trigger ,
Required: False ,
}
string ,
triggerType:
{
Description: Type of the Trigger ,
Enum:
{
Pre: No description available. ,
Post: No description available. ,
}
,
Required: False ,
}
enum ,
triggerOperation:
{
Description: The operation the trigger is associated with ,
Enum:
{
All: No description available. ,
Create: No description available. ,
Update: No description available. ,
Delete: No description available. ,
Replace: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB trigger ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_DeleteSqlTrigger (removed)
Description :  Deletes an existing Azure Cosmos DB SQL trigger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
containerName:
{
Description: Cosmos DB container name. ,
Required: True ,
}
string ,
triggerName:
{
Description: Cosmos DB trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
MongoDBResources_ListMongoDBDatabases (removed)
Description :  Lists the MongoDB databases under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of MongoDB databases and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
MongoDBResources_GetMongoDBDatabase (removed)
Description :  Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_CreateUpdateMongoDBDatabase (removed)
Description :  Create or updates Azure Cosmos DB MongoDB database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateMongoDBDatabaseParameters:
{
Description: The parameters to provide for the current MongoDB database. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB MongoDB database. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a MongoDB database ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB MongoDB database ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_DeleteMongoDBDatabase (removed)
Description :  Deletes an existing Azure Cosmos DB MongoDB database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
MongoDBResources_GetMongoDBDatabaseThroughput (removed)
Description :  Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_UpdateMongoDBDatabaseThroughput (removed)
Description :  Update RUs per second of the an Azure Cosmos DB MongoDB database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current MongoDB database. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBDatabaseToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBDatabaseToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_ListMongoDBCollections (removed)
Description :  Lists the MongoDB collection under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of MongoDB collections and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB collection ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
MongoDBResources_GetMongoDBCollection (removed)
Description :  Gets the MongoDB collection under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB collection ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_CreateUpdateMongoDBCollection (removed)
Description :  Create or update an Azure Cosmos DB MongoDB Collection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateMongoDBCollectionParameters:
{
Description: The parameters to provide for the current MongoDB Collection. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB MongoDB collection. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a MongoDB collection ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB MongoDB collection ,
Required: True ,
}
string ,
shardKey:
{
Description: A key-value pair of shard keys to be applied for the request. ,
Required: False ,
}
object ,
indexes:
{
Description: List of index keys ,
Required: False ,
}
[
{
key:
{
Description: Cosmos DB MongoDB collection index keys ,
Required: False ,
}
{
keys:
{
Description: List of keys for each MongoDB collection in the Azure Cosmos DB service ,
Required: False ,
}
[
string ,
]
,
}
,
options:
{
Description: Cosmos DB MongoDB collection index key options ,
Required: False ,
}
{
expireAfterSeconds:
{
Description: Expire after seconds ,
Required: False ,
}
integer ,
unique:
{
Description: Is unique or not ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Required: False ,
}
integer ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB MongoDB collection ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_DeleteMongoDBCollection (removed)
Description :  Deletes an existing Azure Cosmos DB MongoDB Collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
MongoDBResources_GetMongoDBCollectionThroughput (removed)
Description :  Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_UpdateMongoDBCollectionThroughput (removed)
Description :  Update the RUs per second of an Azure Cosmos DB MongoDB collection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current MongoDB collection. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBCollectionToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
MongoDBResources_MigrateMongoDBCollectionToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
collectionName:
{
Description: Cosmos DB collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_ListTables (removed)
Description :  Lists the Tables under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Table and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
TableResources_GetTable (removed)
Description :  Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
TableResources_CreateUpdateTable (removed)
Description :  Create or update an Azure Cosmos DB Table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateTableParameters:
{
Description: The parameters to provide for the current Table. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Table. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Table ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB table ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
TableResources_DeleteTable (removed)
Description :  Deletes an existing Azure Cosmos DB Table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
TableResources_GetTableThroughput (removed)
Description :  Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_UpdateTableThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB Table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The parameters to provide for the RUs per second of the current Table. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_MigrateTableToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB Table from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
TableResources_MigrateTableToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB Table from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_ListCassandraKeyspaces (removed)
Description :  Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Cassandra keyspaces and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra keyspace ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraKeyspace (removed)
Description :  Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra keyspace ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_CreateUpdateCassandraKeyspace (removed)
Description :  Create or update an Azure Cosmos DB Cassandra keyspace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraKeyspaceParameters:
{
Description: The parameters to provide for the current Cassandra keyspace. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Cassandra keyspace. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Cassandra keyspace ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Cassandra keyspace ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra keyspace ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_DeleteCassandraKeyspace (removed)
Description :  Deletes an existing Azure Cosmos DB Cassandra keyspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
CassandraResources_GetCassandraKeyspaceThroughput (removed)
Description :  Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_UpdateCassandraKeyspaceThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB Cassandra Keyspace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Cassandra Keyspace. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraKeyspaceToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraKeyspaceToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_ListCassandraTables (removed)
Description :  Lists the Cassandra table under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Cassandra tables and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraTable (removed)
Description :  Gets the Cassandra table under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_CreateUpdateCassandraTable (removed)
Description :  Create or update an Azure Cosmos DB Cassandra Table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraTableParameters:
{
Description: The parameters to provide for the current Cassandra Table. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Cassandra table. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Cassandra table ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Cassandra table ,
Required: True ,
}
string ,
defaultTtl:
{
Description: Time to live of the Cosmos DB Cassandra table ,
Required: False ,
}
integer ,
schema:
{
Description: Schema of the Cosmos DB Cassandra table ,
Required: False ,
}
{
columns:
{
Description: List of Cassandra table columns. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB Cassandra table column ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cosmos DB Cassandra table column ,
Required: False ,
}
string ,
}
,
]
,
partitionKeys:
{
Description: List of partition key. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB Cassandra table partition key ,
Required: False ,
}
string ,
}
,
]
,
clusterKeys:
{
Description: List of cluster key. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Cosmos DB Cassandra table cluster key ,
Required: False ,
}
string ,
orderBy:
{
Description: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Required: False ,
}
integer ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra table ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_DeleteCassandraTable (removed)
Description :  Deletes an existing Azure Cosmos DB Cassandra table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
CassandraResources_GetCassandraTableThroughput (removed)
Description :  Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_UpdateCassandraTableThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB Cassandra table
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Cassandra table. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraTableToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraTableToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
keyspaceName:
{
Description: Cosmos DB keyspace name. ,
Required: True ,
}
string ,
tableName:
{
Description: Cosmos DB table name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_ListGremlinDatabases (removed)
Description :  Lists the Gremlin databases under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Gremlin databases and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GremlinResources_GetGremlinDatabase (removed)
Description :  Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_CreateUpdateGremlinDatabase (removed)
Description :  Create or update an Azure Cosmos DB Gremlin database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGremlinDatabaseParameters:
{
Description: The parameters to provide for the current Gremlin database. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Gremlin database. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Gremlin database ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Gremlin database ,
Required: True ,
}
string ,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB SQL database ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_DeleteGremlinDatabase (removed)
Description :  Deletes an existing Azure Cosmos DB Gremlin database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
GremlinResources_GetGremlinDatabaseThroughput (removed)
Description :  Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_UpdateGremlinDatabaseThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB Gremlin database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Gremlin database. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinDatabaseToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinDatabaseToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_ListGremlinGraphs (removed)
Description :  Lists the Gremlin graph under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of graphs and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Gremlin graph ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GremlinResources_GetGremlinGraph (removed)
Description :  Gets the Gremlin graph under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Gremlin graph ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_CreateUpdateGremlinGraph (removed)
Description :  Create or update an Azure Cosmos DB Gremlin graph
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGremlinGraphParameters:
{
Description: The parameters to provide for the current Gremlin graph. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Gremlin graph. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Gremlin graph ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Gremlin graph ,
Required: True ,
}
string ,
indexingPolicy:
{
Description: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph ,
Required: False ,
}
{
automatic:
{
Description: Indicates if the indexing policy is automatic ,
Required: False ,
}
boolean ,
indexingMode:
{
Description: Indicates the indexing mode. ,
Enum:
{
Consistent: No description available. ,
Lazy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
includedPaths:
{
Description: List of paths to include in the indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
indexes:
{
Description: List of indexes for this path ,
Required: False ,
}
[
{
dataType:
{
Description: The datatype for which the indexing behavior is applied to. ,
Enum:
{
String: No description available. ,
Number: No description available. ,
Point: No description available. ,
Polygon: No description available. ,
LineString: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: False ,
}
enum ,
precision:
{
Description: The precision of the index. -1 is maximum precision. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates the type of index. ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
Spatial: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
excludedPaths:
{
Description: List of paths to exclude from indexing ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
}
,
]
,
compositeIndexes:
{
Description: List of composite path list ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
order:
{
Description: Sort order for composite paths. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
spatialIndexes:
{
Description: List of spatial specifics ,
Required: False ,
}
[
{
path:
{
Description: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ,
Required: False ,
}
string ,
types:
{
Description: List of path's spatial type ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
partitionKey:
{
Description: The configuration of the partition key to be used for partitioning data into multiple partitions ,
Required: False ,
}
{
paths:
{
Description: List of paths using which data within the container can be partitioned ,
Required: False ,
}
[
string ,
]
,
kind:
{
Description: Indicates the kind of algorithm used for partitioning ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Indicates the version of the partition key definition ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultTtl:
{
Description: Default time to live ,
Required: False ,
}
integer ,
uniqueKeyPolicy:
{
Description: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
{
uniqueKeys:
{
Description: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. ,
Required: False ,
}
[
{
paths:
{
Description: List of paths must be unique for each document in the Azure Cosmos DB service ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
conflictResolutionPolicy:
{
Description: The conflict resolution policy for the graph. ,
Required: False ,
}
{
mode:
{
Description: Indicates the conflict resolution mode. ,
Enum:
{
LastWriterWins: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
conflictResolutionPath:
{
Description: The conflict resolution path in the case of LastWriterWins mode. ,
Required: False ,
}
string ,
conflictResolutionProcedure:
{
Description: The procedure to resolve conflicts in the case of custom mode. ,
Required: False ,
}
string ,
}
,
}
,
options:
{
Description: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. ,
Required: True ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB Gremlin graph ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_DeleteGremlinGraph (removed)
Description :  Deletes an existing Azure Cosmos DB Gremlin graph.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
GremlinResources_GetGremlinGraphThroughput (removed)
Description :  Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_UpdateGremlinGraphThroughput (removed)
Description :  Update RUs per second of an Azure Cosmos DB Gremlin graph
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateThroughputParameters:
{
Description: The RUs per second of the parameters to provide for the current Gremlin graph. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB resource throughput. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughput:
{
Description: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput container can scale up to. ,
Required: True ,
}
integer ,
autoUpgradePolicy:
{
Description: Cosmos DB resource auto-upgrade policy ,
Required: False ,
}
{
throughputPolicy:
{
Description: Represents throughput policy which service must adhere to for auto-upgrade ,
Required: False ,
}
{
isEnabled:
{
Description: Determines whether the ThroughputPolicy is active or not ,
Required: False ,
}
boolean ,
incrementPercent:
{
Description: Represents the percentage by which throughput can increase every time throughput policy kicks in. ,
Required: False ,
}
integer ,
}
,
}
,
targetMaxThroughput:
{
Description: Represents target maximum throughput container can scale up to once offer is no longer in pending state. ,
Required: False ,
}
integer ,
}
,
minimumThroughput:
{
Description: The minimum throughput of the resource ,
Required: False ,
}
string ,
offerReplacePending:
{
Description: The throughput replace is pending ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinGraphToAutoscale (removed)
Description :  Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
GremlinResources_MigrateGremlinGraphToManualThroughput (removed)
Description :  Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
databaseName:
{
Description: Cosmos DB database name. ,
Required: True ,
}
string ,
graphName:
{
Description: Cosmos DB graph name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
NotebookWorkspaces_ListByDatabaseAccount (removed)
Description :  Gets the notebook workspace resources of an existing Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of notebook workspace resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
status:
{
Description: Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_Get (removed)
Description :  Gets the notebook workspace for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
status:
{
Description: Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_CreateOrUpdate (removed)
Description :  Creates the notebook workspace for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
notebookCreateUpdateParameters:
{
Description: The notebook workspace to create for the current database account. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
status:
{
Description: Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_Delete (removed)
Description :  Deletes the notebook workspace for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_ListConnectionInfo (removed)
Description :  Retrieves the connection info for the notebook workspace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/listConnectionInfo
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authToken:
{
Description: Specifies auth token used for connecting to Notebook server (uses token-based auth). ,
Required: False ,
}
string ,
notebookServerEndpoint:
{
Description: Specifies the endpoint of Notebook server. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_RegenerateAuthToken (removed)
Description :  Regenerates the auth token for the notebook workspace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/regenerateAuthToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NotebookWorkspaces_Start (removed)
Description :  Starts the notebook workspace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/start
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
notebookWorkspaceName:
{
Description: The name of the notebook workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}