Microsoft.DocumentDB (preview:2025-05-01)

2025/04/27 • 300 new methods

CassandraResources_GetCassandraRoleDefinition (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Definition with the given Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions/{roleDefinitionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleDefinitionId:
{
Description: The GUID for the Role Definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Cassandra Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_CreateUpdateCassandraRoleDefinition (new)
Description :  Creates or updates an Azure Cosmos DB Cassandra Role Definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions/{roleDefinitionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleDefinitionId:
{
Description: The GUID for the Role Definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraRoleDefinitionParameters:
{
Description: The properties required to create or update a Role Definition. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Cassandra Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Cassandra Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_DeleteCassandraRoleDefinition (new)
Description :  Deletes an existing Azure Cosmos DB Cassandra Role Definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions/{roleDefinitionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleDefinitionId:
{
Description: The GUID for the Role Definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_ListCassandraRoleDefinitions (new)
Description :  Retrieves the list of all Azure Cosmos DB Cassandra Role Definitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Role Definitions and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Cassandra Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_GetCassandraRoleAssignment (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Assignment with the given Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments/{roleAssignmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleAssignmentId:
{
Description: The GUID for the Role Assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Cassandra Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Cassandra Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_CreateUpdateCassandraRoleAssignment (new)
Description :  Creates or updates an Azure Cosmos DB Cassandra Role Assignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments/{roleAssignmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleAssignmentId:
{
Description: The GUID for the Role Assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraRoleAssignmentParameters:
{
Description: The properties required to create or update a Role Assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Cassandra Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Cassandra Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Cassandra Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Cassandra Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_DeleteCassandraRoleAssignment (new)
Description :  Deletes an existing Azure Cosmos DB Cassandra Role Assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments/{roleAssignmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleAssignmentId:
{
Description: The GUID for the Role Assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraResources_ListCassandraRoleAssignments (new)
Description :  Retrieves the list of all Azure Cosmos DB Cassandra Role Assignments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Role Assignments and their properties ,
Required: False ,
}
[
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Cassandra Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Cassandra Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Cassandra Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChaosFault_List (new)
Description :  List Chaos Faults for CosmosDB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: List of Chaos Faults. ,
Required: False ,
}
[
{
properties:
{
Description: A request object to enable/disable the chaos fault. ,
Required: False ,
}
{
action:
{
Description: Indicates whether what action to take for the Chaos Fault. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: Region of the account where the Chaos Fault is to be enabled/disabled. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
containerName:
{
Description: Container name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: A provisioning state of the Chaos Fault. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChaosFault_EnableDisable (new)
Description :  Enable, disable Chaos Fault in a CosmosDB account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
chaosFault:
{
Description: The name of the ChaosFault. ,
Required: True ,
}
string ,
chaosFaultRequest:
{
Description: A request object to enable/disable the chaos fault. ,
Required: True ,
}
{
properties:
{
Description: A request object to enable/disable the chaos fault. ,
Required: False ,
}
{
action:
{
Description: Indicates whether what action to take for the Chaos Fault. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: Region of the account where the Chaos Fault is to be enabled/disabled. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
containerName:
{
Description: Container name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: A provisioning state of the Chaos Fault. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A request object to enable/disable the chaos fault. ,
Required: False ,
}
{
action:
{
Description: Indicates whether what action to take for the Chaos Fault. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: Region of the account where the Chaos Fault is to be enabled/disabled. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
containerName:
{
Description: Container name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: A provisioning state of the Chaos Fault. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: A request object to enable/disable the chaos fault. ,
Required: False ,
}
{
action:
{
Description: Indicates whether what action to take for the Chaos Fault. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: Region of the account where the Chaos Fault is to be enabled/disabled. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
containerName:
{
Description: Container name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: A provisioning state of the Chaos Fault. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChaosFault_Get (new)
Description :  Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
chaosFault:
{
Description: The name of the ChaosFault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A request object to enable/disable the chaos fault. ,
Required: False ,
}
{
action:
{
Description: Indicates whether what action to take for the Chaos Fault. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: Region of the account where the Chaos Fault is to be enabled/disabled. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
containerName:
{
Description: Container name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: A provisioning state of the Chaos Fault. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CopyJobs_Create (new)
Description :  Creates a Copy Job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}
{
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 ,
jobName:
{
Description: Name of the Copy Job ,
Required: True ,
}
string ,
jobCreateParameters:
{
Required: True ,
}
{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CopyJobs_Get (new)
Description :  Get a Copy Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}
{
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 ,
jobName:
{
Description: Name of the Copy Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CopyJobs_Pause (new)
Description :  Pause a Copy Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/pause
{
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 ,
jobName:
{
Description: Name of the Copy Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CopyJobs_Resume (new)
Description :  Resumes a Copy Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/resume
{
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 ,
jobName:
{
Description: Name of the Copy Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CopyJobs_Cancel (new)
Description :  Cancels a Copy Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/cancel
{
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 ,
jobName:
{
Description: Name of the Copy Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CopyJobs_Complete (new)
Description :  Completes an Online Copy Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/complete
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
jobName:
{
Description: Name of the Copy Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CopyJobs_ListByDatabaseAccount (new)
Description :  Get a list of Copy jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs
{
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 Copy Jobs and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a Copy Job ,
Required: True ,
}
{
jobProperties:
{
Description: Job Properties ,
Required: True ,
}
{
jobType:
{
Description: Copy Job Type ,
Enum:
{
CassandraRUToCassandraRU: No description available. ,
CassandraRUToAzureBlobStorage: No description available. ,
AzureBlobStorageToCassandraRU: No description available. ,
MongoRUToMongoRU: No description available. ,
MongoRUToMongoVCore: No description available. ,
NoSqlRUToNoSqlRU: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Enum:
{
Pending: No description available. ,
Partitioning: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
processedCount:
{
Description: Processed Count ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Copy Job list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceId:
{
Description: A unique identifier assigned to the database account ,
Required: False ,
}
string ,
createMode:
{
Description: Enum to indicate the mode of account creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore. ,
Required: False ,
}
{
restoreMode:
{
Description: Describes the mode of the restore. ,
Enum:
{
PointInTime: No description available. ,
}
,
Required: False ,
}
enum ,
restoreSource:
{
Description: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ,
Required: False ,
}
string ,
restoreTimestampInUtc:
{
Description: Time to which the account has to be restored (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
databasesToRestore:
{
Description: List of specific databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database available for restore. ,
Required: False ,
}
string ,
collectionNames:
{
Description: The names of the collections available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
{
Description: List of specific gremlin databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the gremlin database available for restore. ,
Required: False ,
}
string ,
graphNames:
{
Description: The names of the graphs available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
tablesToRestore:
{
Description: List of specific tables available for restore. ,
Required: False ,
}
[
string ,
]
,
sourceBackupLocation:
{
Description: The source backup location for restore. ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeChangeTransitionState:
{
Description: The object that represents the migration state for the CapacityMode of the Cosmos DB account. ,
Required: False ,
}
{
capacityModeTransitionStatus:
{
Description: The transition status of capacity mode. ,
Enum:
{
Invalid: No description available. ,
Initialized: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
currentCapacityMode:
{
Description: Indicates the current capacity mode of the account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
previousCapacityMode:
{
Description: Indicates the previous capacity mode of the account before successful transition. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeTransitionBeginTimestamp:
{
Description: Begin time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeTransitionEndTimestamp:
{
Description: End time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeLastSuccessfulTransitionEndTimestamp:
{
Description: End time in UTC of the last successful capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: The object that represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: This property is ignored during the update operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceId:
{
Description: A unique identifier assigned to the database account ,
Required: False ,
}
string ,
createMode:
{
Description: Enum to indicate the mode of account creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore. ,
Required: False ,
}
{
restoreMode:
{
Description: Describes the mode of the restore. ,
Enum:
{
PointInTime: No description available. ,
}
,
Required: False ,
}
enum ,
restoreSource:
{
Description: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ,
Required: False ,
}
string ,
restoreTimestampInUtc:
{
Description: Time to which the account has to be restored (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
databasesToRestore:
{
Description: List of specific databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database available for restore. ,
Required: False ,
}
string ,
collectionNames:
{
Description: The names of the collections available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
{
Description: List of specific gremlin databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the gremlin database available for restore. ,
Required: False ,
}
string ,
graphNames:
{
Description: The names of the graphs available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
tablesToRestore:
{
Description: List of specific tables available for restore. ,
Required: False ,
}
[
string ,
]
,
sourceBackupLocation:
{
Description: The source backup location for restore. ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeChangeTransitionState:
{
Description: The object that represents the migration state for the CapacityMode of the Cosmos DB account. ,
Required: False ,
}
{
capacityModeTransitionStatus:
{
Description: The transition status of capacity mode. ,
Enum:
{
Invalid: No description available. ,
Initialized: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
currentCapacityMode:
{
Description: Indicates the current capacity mode of the account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
previousCapacityMode:
{
Description: Indicates the previous capacity mode of the account before successful transition. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeTransitionBeginTimestamp:
{
Description: Begin time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeTransitionEndTimestamp:
{
Description: End time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeLastSuccessfulTransitionEndTimestamp:
{
Description: End time in UTC of the last successful capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: The object that represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Enum to indicate the mode of account creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore. ,
Required: False ,
}
{
restoreMode:
{
Description: Describes the mode of the restore. ,
Enum:
{
PointInTime: No description available. ,
}
,
Required: False ,
}
enum ,
restoreSource:
{
Description: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ,
Required: False ,
}
string ,
restoreTimestampInUtc:
{
Description: Time to which the account has to be restored (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
databasesToRestore:
{
Description: List of specific databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database available for restore. ,
Required: False ,
}
string ,
collectionNames:
{
Description: The names of the collections available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
{
Description: List of specific gremlin databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the gremlin database available for restore. ,
Required: False ,
}
string ,
graphNames:
{
Description: The names of the graphs available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
tablesToRestore:
{
Description: List of specific tables available for restore. ,
Required: False ,
}
[
string ,
]
,
sourceBackupLocation:
{
Description: The source backup location for restore. ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceId:
{
Description: A unique identifier assigned to the database account ,
Required: False ,
}
string ,
createMode:
{
Description: Enum to indicate the mode of account creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore. ,
Required: False ,
}
{
restoreMode:
{
Description: Describes the mode of the restore. ,
Enum:
{
PointInTime: No description available. ,
}
,
Required: False ,
}
enum ,
restoreSource:
{
Description: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ,
Required: False ,
}
string ,
restoreTimestampInUtc:
{
Description: Time to which the account has to be restored (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
databasesToRestore:
{
Description: List of specific databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database available for restore. ,
Required: False ,
}
string ,
collectionNames:
{
Description: The names of the collections available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
{
Description: List of specific gremlin databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the gremlin database available for restore. ,
Required: False ,
}
string ,
graphNames:
{
Description: The names of the graphs available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
tablesToRestore:
{
Description: List of specific tables available for restore. ,
Required: False ,
}
[
string ,
]
,
sourceBackupLocation:
{
Description: The source backup location for restore. ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeChangeTransitionState:
{
Description: The object that represents the migration state for the CapacityMode of the Cosmos DB account. ,
Required: False ,
}
{
capacityModeTransitionStatus:
{
Description: The transition status of capacity mode. ,
Enum:
{
Invalid: No description available. ,
Initialized: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
currentCapacityMode:
{
Description: Indicates the current capacity mode of the account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
previousCapacityMode:
{
Description: Indicates the previous capacity mode of the account before successful transition. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeTransitionBeginTimestamp:
{
Description: Begin time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeTransitionEndTimestamp:
{
Description: End time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeLastSuccessfulTransitionEndTimestamp:
{
Description: End time in UTC of the last successful capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: The object that represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceId:
{
Description: A unique identifier assigned to the database account ,
Required: False ,
}
string ,
createMode:
{
Description: Enum to indicate the mode of account creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore. ,
Required: False ,
}
{
restoreMode:
{
Description: Describes the mode of the restore. ,
Enum:
{
PointInTime: No description available. ,
}
,
Required: False ,
}
enum ,
restoreSource:
{
Description: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ,
Required: False ,
}
string ,
restoreTimestampInUtc:
{
Description: Time to which the account has to be restored (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
databasesToRestore:
{
Description: List of specific databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database available for restore. ,
Required: False ,
}
string ,
collectionNames:
{
Description: The names of the collections available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
{
Description: List of specific gremlin databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the gremlin database available for restore. ,
Required: False ,
}
string ,
graphNames:
{
Description: The names of the graphs available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
tablesToRestore:
{
Description: List of specific tables available for restore. ,
Required: False ,
}
[
string ,
]
,
sourceBackupLocation:
{
Description: The source backup location for restore. ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeChangeTransitionState:
{
Description: The object that represents the migration state for the CapacityMode of the Cosmos DB account. ,
Required: False ,
}
{
capacityModeTransitionStatus:
{
Description: The transition status of capacity mode. ,
Enum:
{
Invalid: No description available. ,
Initialized: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
currentCapacityMode:
{
Description: Indicates the current capacity mode of the account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
previousCapacityMode:
{
Description: Indicates the previous capacity mode of the account before successful transition. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeTransitionBeginTimestamp:
{
Description: Begin time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeTransitionEndTimestamp:
{
Description: End time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeLastSuccessfulTransitionEndTimestamp:
{
Description: End time in UTC of the last successful capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: The object that represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
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 ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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}. ,
Format: arm-id ,
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 ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
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 ,
defaultIdentity:
{
Description: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: 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 version of the MongoDB account. ,
Enum:
{
3.2: No description available. ,
3.6: No description available. ,
4.0: No description available. ,
4.2: No description available. ,
5.0: No description available. ,
6.0: No description available. ,
7.0: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableAnalyticalStorage:
{
Description: Flag to indicate whether to enable storage analytics. ,
Required: False ,
}
boolean ,
analyticalStorageConfiguration:
{
Description: Analytical storage specific properties. ,
Required: False ,
}
{
schemaType:
{
Description: Describes the types of schema for analytical storage. ,
Enum:
{
WellDefined: No description available. ,
FullFidelity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceId:
{
Description: A unique identifier assigned to the database account ,
Required: False ,
}
string ,
createMode:
{
Description: Enum to indicate the mode of account creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore. ,
Required: False ,
}
{
restoreMode:
{
Description: Describes the mode of the restore. ,
Enum:
{
PointInTime: No description available. ,
}
,
Required: False ,
}
enum ,
restoreSource:
{
Description: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ,
Required: False ,
}
string ,
restoreTimestampInUtc:
{
Description: Time to which the account has to be restored (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
databasesToRestore:
{
Description: List of specific databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database available for restore. ,
Required: False ,
}
string ,
collectionNames:
{
Description: The names of the collections available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
{
Description: List of specific gremlin databases available for restore. ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the gremlin database available for restore. ,
Required: False ,
}
string ,
graphNames:
{
Description: The names of the graphs available for restore. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
tablesToRestore:
{
Description: List of specific tables available for restore. ,
Required: False ,
}
[
string ,
]
,
sourceBackupLocation:
{
Description: The source backup location for restore. ,
Required: False ,
}
string ,
}
,
backupPolicy:
{
Description: The object representing the policy for taking backups on an account. ,
Required: False ,
}
{
type:
{
Description: Describes the mode of backups. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: True ,
}
enum ,
migrationState:
{
Description: The object representing the state of the migration between the backup policies. ,
Required: False ,
}
{
status:
{
Description: Describes the status of migration between backup policy types. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetType:
{
Description: Describes the target backup policy type of the backup policy migration. ,
Enum:
{
Periodic: No description available. ,
Continuous: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time at which the backup policy migration started (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
networkAclBypass:
{
Description: Indicates what services are allowed to bypass firewall checks. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
networkAclBypassResourceIds:
{
Description: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. ,
Required: False ,
}
[
string ,
]
,
diagnosticLogSettings:
{
Description: The Object representing the different Diagnostic log settings for the Cosmos DB Account. ,
Required: False ,
}
{
enableFullTextQuery:
{
Description: Describe the level of detail with which queries are to be logged. ,
Enum:
{
None: No description available. ,
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
capacity:
{
Description: The object that represents all properties related to capacity enforcement on an account. ,
Required: False ,
}
{
totalThroughputLimit:
{
Description: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacityMode:
{
Description: Indicates the capacityMode of the Cosmos DB account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeChangeTransitionState:
{
Description: The object that represents the migration state for the CapacityMode of the Cosmos DB account. ,
Required: False ,
}
{
capacityModeTransitionStatus:
{
Description: The transition status of capacity mode. ,
Enum:
{
Invalid: No description available. ,
Initialized: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
currentCapacityMode:
{
Description: Indicates the current capacity mode of the account. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
previousCapacityMode:
{
Description: Indicates the previous capacity mode of the account before successful transition. ,
Enum:
{
None: No description available. ,
Provisioned: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
capacityModeTransitionBeginTimestamp:
{
Description: Begin time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeTransitionEndTimestamp:
{
Description: End time in UTC of the capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
capacityModeLastSuccessfulTransitionEndTimestamp:
{
Description: End time in UTC of the last successful capacity mode change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
enableMaterializedViews:
{
Description: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account ,
Required: False ,
}
boolean ,
keysMetadata:
{
Description: The object that represents the metadata for the Account Keys of the Cosmos DB account. ,
Required: False ,
}
{
primaryMasterKey:
{
Description: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryMasterKey:
{
Description: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
primaryReadonlyMasterKey:
{
Description: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryReadonlyMasterKey:
{
Description: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. ,
Required: False ,
}
{
generationTime:
{
Description: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
enablePartitionMerge:
{
Description: Flag to indicate enabling/disabling of Partition Merge feature on the account ,
Required: False ,
}
boolean ,
enableBurstCapacity:
{
Description: Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account ,
Required: False ,
}
boolean ,
minimalTlsVersion:
{
Description: Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2. ,
Enum:
{
Tls: No description available. ,
Tls11: No description available. ,
Tls12: No description available. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyStatus:
{
Description: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. ,
Required: False ,
}
string ,
enablePriorityBasedExecution:
{
Description: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account ,
Required: False ,
}
boolean ,
defaultPriorityLevel:
{
Description: Enum to indicate default Priority Level of request for Priority Based Execution. ,
Enum:
{
High: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
enablePerRegionPerPartitionAutoscale:
{
Description: Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account ,
Required: False ,
}
boolean ,
enableAllVersionsAndDeletesChangeFeed:
{
Description: Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
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 ,
keyKind:
{
Description: Kind of the connection string key ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
PrimaryReadonly: No description available. ,
SecondaryReadonly: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of the connection string ,
Enum:
{
Sql: No description available. ,
Table: No description available. ,
MongoDB: No description available. ,
Cassandra: No description available. ,
CassandraConnectorMetadata: No description available. ,
Gremlin: No description available. ,
SqlDedicatedGateway: No description available. ,
GremlinV2: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}
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 ,
}
,
}
,
]
,
}
GraphResources_ListGraphs (new)
Description :  Lists the graphs under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Graph resource and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Graph resource. ,
Required: False ,
}
{
resource:
{
Required: False ,
}
object ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GraphResources_GetGraph (new)
Description :  Gets the Graph resource 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}/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 ,
graphName:
{
Description: Cosmos DB graph resource 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 Graph resource. ,
Required: False ,
}
{
resource:
{
Required: False ,
}
object ,
options:
{
Required: False ,
}
string ,
}
,
}
GraphResources_CreateUpdateGraph (new)
Description :  Create or update an Azure Cosmos DB Graph.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/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 ,
graphName:
{
Description: Cosmos DB graph resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGraphParameters:
{
Description: The parameters to provide for the current graph. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Graph resource. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Graph resource ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Graph ,
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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/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 ,
graphName:
{
Description: Cosmos DB graph resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}
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 ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SqlResources_ListClientEncryptionKeys (new)
Description :  Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys
{
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 client encryption keys and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a ClientEncryptionKey ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
SqlResources_GetClientEncryptionKey (new)
Description :  Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
{
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 ,
clientEncryptionKeyName:
{
Description: Cosmos DB ClientEncryptionKey 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 a ClientEncryptionKey ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}
SqlResources_CreateUpdateClientEncryptionKey (new)
Description :  Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
{
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 ,
clientEncryptionKeyName:
{
Description: Cosmos DB ClientEncryptionKey name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateClientEncryptionKeyParameters:
{
Description: The parameters to provide for the client encryption key. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update ClientEncryptionKey. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a ClientEncryptionKey ,
Required: True ,
}
{
id:
{
Description: Name of the ClientEncryptionKey ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. ,
Required: False ,
}
string ,
wrappedDataEncryptionKey:
{
Description: Wrapped (encrypted) form of the key represented as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
keyWrapMetadata:
{
Description: Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key. ,
Required: False ,
}
{
name:
{
Description: The name of associated KeyEncryptionKey (aka CustomerManagedKey). ,
Required: False ,
}
string ,
type:
{
Description: ProviderName of KeyStoreProvider. ,
Required: False ,
}
string ,
value:
{
Description: Reference / link to the KeyEncryptionKey. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm used in wrapping and unwrapping of the data encryption key. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a ClientEncryptionKey ,
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 ,
]
,
}
,
]
,
vectorIndexes:
{
Description: List of paths to include in the vector indexing ,
Required: False ,
}
[
{
path:
{
Description: The path to the vector field in the document. ,
Required: True ,
}
string ,
type:
{
Description: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. ,
Enum:
{
flat: No description available. ,
diskANN: No description available. ,
quantizedFlat: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
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. For MultiHash, multiple partition keys (upto three maximum) are supported for container create ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
MultiHash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Indicates the version of the partition key definition ,
Format: int32 ,
Required: False ,
}
integer ,
systemKey:
{
Description: Indicates if the container is using a system generated partition key ,
Required: False ,
}
boolean ,
}
,
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 ,
}
,
clientEncryptionPolicy:
{
Description: The client encryption policy for the container. ,
Required: False ,
}
{
includedPaths:
{
Description: Paths of the item that need encryption along with path-specific settings. ,
Required: True ,
}
[
{
path:
{
Description: Path that needs to be encrypted. ,
Required: True ,
}
string ,
clientEncryptionKeyId:
{
Description: The identifier of the Client Encryption Key to be used to encrypt the path. ,
Required: True ,
}
string ,
encryptionType:
{
Description: The type of encryption to be performed. Eg - Deterministic, Randomized. ,
Required: True ,
}
string ,
encryptionAlgorithm:
{
Description: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. ,
Required: True ,
}
string ,
}
,
]
,
policyFormatVersion:
{
Description: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Format: int64 ,
Required: False ,
}
integer ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
materializedViewDefinition:
{
Description: The configuration for defining Materialized Views. This must be specified only for creating a Materialized View container. ,
Required: False ,
}
{
sourceCollectionRid:
{
Description: An unique identifier for the source collection. This is a system generated property. ,
Required: False ,
}
string ,
sourceCollectionId:
{
Description: The name of the source container on which the Materialized View will be created. ,
Required: True ,
}
string ,
definition:
{
Description: The definition should be an SQL query which would be used to fetch data from the source container to populate into the Materialized View container. ,
Required: True ,
}
string ,
}
,
materializedViews:
{
Description: Materialized Views defined on the container. ,
Required: False ,
}
[
{
id:
{
Description: Id field of Materialized container. ,
Required: False ,
}
string ,
_rid:
{
Description: _rid field of Materialized container. ,
Required: False ,
}
string ,
}
,
]
,
computedProperties:
{
Description: List of computed properties ,
Required: False ,
}
[
{
name:
{
Description: The name of a computed property, for example - "cp_lowerName" ,
Required: False ,
}
string ,
query:
{
Description: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c" ,
Required: False ,
}
string ,
}
,
]
,
vectorEmbeddingPolicy:
{
Description: The vector embedding policy for the container. ,
Required: False ,
}
{
vectorEmbeddings:
{
Description: List of vector embeddings ,
Required: False ,
}
[
{
path:
{
Description: The path to the vector field in the document. ,
Required: True ,
}
string ,
dataType:
{
Description: Indicates the data type of vector. ,
Enum:
{
float32: No description available. ,
uint8: No description available. ,
int8: No description available. ,
}
,
Required: True ,
}
enum ,
distanceFunction:
{
Description: The distance function to use for distance calculation in between vectors. ,
Enum:
{
euclidean: No description available. ,
cosine: No description available. ,
dotproduct: No description available. ,
}
,
Required: True ,
}
enum ,
dimensions:
{
Description: The number of dimensions in the vector. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
fullTextPolicy:
{
Description: The FullText policy for the container. ,
Required: False ,
}
{
defaultLanguage:
{
Description: The default language for a full text paths. ,
Required: False ,
}
string ,
fullTextPaths:
{
Description: List of FullText Paths ,
Required: False ,
}
[
{
path:
{
Description: The path to the full text field in the document. ,
Required: True ,
}
string ,
language:
{
Description: The language of the full text field in the document. ,
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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}
SqlResources_SqlDatabasePartitionMerge (new)
Description :  Merges the partitions of a SQL database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/partitionMerge
{
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 ,
mergeParameters:
{
Description: The parameters for the merge operation. ,
Required: True ,
}
{
isDryRun:
{
Description: Specifies whether the operation is a real merge operation or a simulation. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
{
Description: List of physical partitions and their properties. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the partition. ,
Required: False ,
}
string ,
storageInKB:
{
Description: The storage in KB for the physical partition. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SqlResources_ListSqlContainerPartitionMerge (new)
Description :  Merges the partitions of a SQL Container
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/partitionMerge
{
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 ,
mergeParameters:
{
Description: The parameters for the merge operation. ,
Required: True ,
}
{
isDryRun:
{
Description: Specifies whether the operation is a real merge operation or a simulation. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
{
Description: List of physical partitions and their properties. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the partition. ,
Required: False ,
}
string ,
storageInKB:
{
Description: The storage in KB for the physical partition. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SqlResources_SqlDatabaseRetrieveThroughputDistribution (new)
Description :  Retrieve throughput distribution for an Azure Cosmos DB SQL database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution
{
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 ,
retrieveThroughputParameters:
{
Description: The parameters to provide for retrieving throughput distribution for the current SQL database. ,
Required: True ,
}
{
properties:
{
Description: Properties to retrieve throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
physicalPartitionIds:
{
Description: Array of PhysicalPartitionId objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SqlResources_SqlDatabaseRedistributeThroughput (new)
Description :  Redistribute throughput for an Azure Cosmos DB SQL database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/redistributeThroughput
{
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 ,
redistributeThroughputParameters:
{
Description: The parameters to provide for redistributing throughput for the current SQL database. ,
Required: True ,
}
{
properties:
{
Description: Properties to redistribute throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughputPolicy:
{
Description: ThroughputPolicy to apply for throughput redistribution ,
Enum:
{
none: No description available. ,
equal: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
targetPhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SqlResources_SqlContainerRetrieveThroughputDistribution (new)
Description :  Retrieve throughput distribution for an Azure Cosmos DB SQL container
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution
{
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 ,
retrieveThroughputParameters:
{
Description: The parameters to provide for retrieving throughput distribution for the current SQL container. ,
Required: True ,
}
{
properties:
{
Description: Properties to retrieve throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
physicalPartitionIds:
{
Description: Array of PhysicalPartitionId objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SqlResources_SqlContainerRedistributeThroughput (new)
Description :  Redistribute throughput for an Azure Cosmos DB SQL container
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/redistributeThroughput
{
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 ,
redistributeThroughputParameters:
{
Description: The parameters to provide for redistributing throughput for the current SQL container. ,
Required: True ,
}
{
properties:
{
Description: Properties to redistribute throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughputPolicy:
{
Description: ThroughputPolicy to apply for throughput redistribution ,
Enum:
{
none: No description available. ,
equal: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
targetPhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MongoDBResources_MongoDBDatabaseRetrieveThroughputDistribution (new)
Description :  Retrieve throughput distribution for an Azure Cosmos DB MongoDB database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution
{
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 ,
retrieveThroughputParameters:
{
Description: The parameters to provide for retrieving throughput distribution for the current MongoDB database. ,
Required: True ,
}
{
properties:
{
Description: Properties to retrieve throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
physicalPartitionIds:
{
Description: Array of PhysicalPartitionId objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MongoDBResources_MongoDBDatabaseRedistributeThroughput (new)
Description :  Redistribute throughput for an Azure Cosmos DB MongoDB database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/redistributeThroughput
{
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 ,
redistributeThroughputParameters:
{
Description: The parameters to provide for redistributing throughput for the current MongoDB database. ,
Required: True ,
}
{
properties:
{
Description: Properties to redistribute throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughputPolicy:
{
Description: ThroughputPolicy to apply for throughput redistribution ,
Enum:
{
none: No description available. ,
equal: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
targetPhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MongoDBResources_MongoDBContainerRetrieveThroughputDistribution (new)
Description :  Retrieve throughput distribution for an Azure Cosmos DB MongoDB container
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution
{
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 ,
retrieveThroughputParameters:
{
Description: The parameters to provide for retrieving throughput distribution for the current MongoDB container. ,
Required: True ,
}
{
properties:
{
Description: Properties to retrieve throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
physicalPartitionIds:
{
Description: Array of PhysicalPartitionId objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MongoDBResources_MongoDBContainerRedistributeThroughput (new)
Description :  Redistribute throughput for an Azure Cosmos DB MongoDB container
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput
{
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 ,
redistributeThroughputParameters:
{
Description: The parameters to provide for redistributing throughput for the current MongoDB container. ,
Required: True ,
}
{
properties:
{
Description: Properties to redistribute throughput parameters object ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a resource throughput ,
Required: True ,
}
{
throughputPolicy:
{
Description: ThroughputPolicy to apply for throughput redistribution ,
Enum:
{
none: No description available. ,
equal: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
targetPhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
{
Description: Array of PhysicalPartitionThroughputInfoResource objects. ,
Required: True ,
}
[
{
id:
{
Description: Id of a physical partition ,
Required: True ,
}
string ,
throughput:
{
Description: Throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
targetThroughput:
{
Description: Target throughput of a physical partition ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object ,
Required: False ,
}
{
resource:
{
Description: properties of physical partition throughput info ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}
MongoDBResources_MongoDBDatabasePartitionMerge (new)
Description :  Merges the partitions of a MongoDB database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/partitionMerge
{
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 ,
mergeParameters:
{
Description: The parameters for the merge operation. ,
Required: True ,
}
{
isDryRun:
{
Description: Specifies whether the operation is a real merge operation or a simulation. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
{
Description: List of physical partitions and their properties. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the partition. ,
Required: False ,
}
string ,
storageInKB:
{
Description: The storage in KB for the physical partition. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MongoDBResources_ListMongoDBCollectionPartitionMerge (new)
Description :  Merges the partitions of a MongoDB Collection
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/partitionMerge
{
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 ,
mergeParameters:
{
Description: The parameters for the merge operation. ,
Required: True ,
}
{
isDryRun:
{
Description: Specifies whether the operation is a real merge operation or a simulation. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
{
Description: List of physical partitions and their properties. ,
Required: False ,
}
[
{
id:
{
Description: The unique identifier of the partition. ,
Required: False ,
}
string ,
storageInKB:
{
Description: The storage in KB for the physical partition. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
]
,
}
,
]
,
vectorIndexes:
{
Description: List of paths to include in the vector indexing ,
Required: False ,
}
[
{
path:
{
Description: The path to the vector field in the document. ,
Required: True ,
}
string ,
type:
{
Description: The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. ,
Enum:
{
flat: No description available. ,
diskANN: No description available. ,
quantizedFlat: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
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. For MultiHash, multiple partition keys (upto three maximum) are supported for container create ,
Enum:
{
Hash: No description available. ,
Range: No description available. ,
MultiHash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Indicates the version of the partition key definition ,
Format: int32 ,
Required: False ,
}
integer ,
systemKey:
{
Description: Indicates if the container is using a system generated partition key ,
Required: False ,
}
boolean ,
}
,
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 ,
}
,
analyticalStorageTtl:
{
Description: Analytical TTL. ,
Format: int64 ,
Required: False ,
}
integer ,
restoreParameters:
{
Description: Parameters to indicate the information about the restore ,
Required: False ,
}
object ,
createMode:
{
Description: Enum to indicate the mode of resource creation. ,
Enum:
{
Default: No description available. ,
Restore: 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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
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_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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ 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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Locations_List (new)
Description :  List Cosmos DB locations and their properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations
{
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 Cosmos DB locations and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Cosmos DB location metadata ,
Required: False ,
}
{
supportsAvailabilityZone:
{
Description: Flag indicating whether the location supports availability zones or not. ,
Required: False ,
}
boolean ,
isResidencyRestricted:
{
Description: Flag indicating whether the location is residency sensitive. ,
Required: False ,
}
boolean ,
backupStorageRedundancies:
{
Description: The properties of available backup storage redundancies. ,
Required: False ,
}
[
string ,
]
,
isSubscriptionRegionAccessAllowedForRegular:
{
Description: Flag indicating whether the subscription have access in region for Non-Availability Zones. ,
Required: False ,
}
boolean ,
isSubscriptionRegionAccessAllowedForAz:
{
Description: Flag indicating whether the subscription have access in region for Availability Zones(Az). ,
Required: False ,
}
boolean ,
status:
{
Description: Enum to indicate current buildout status of the region. ,
Enum:
{
Uninitialized: No description available. ,
Initializing: No description available. ,
InternallyReady: No description available. ,
Online: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Locations_Get (new)
Description :  Get the properties of an existing Cosmos DB location
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}
{
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 ,
location:
{
Description: Cosmos DB region, with spaces between words and each word capitalized. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cosmos DB location metadata ,
Required: False ,
}
{
supportsAvailabilityZone:
{
Description: Flag indicating whether the location supports availability zones or not. ,
Required: False ,
}
boolean ,
isResidencyRestricted:
{
Description: Flag indicating whether the location is residency sensitive. ,
Required: False ,
}
boolean ,
backupStorageRedundancies:
{
Description: The properties of available backup storage redundancies. ,
Required: False ,
}
[
string ,
]
,
isSubscriptionRegionAccessAllowedForRegular:
{
Description: Flag indicating whether the subscription have access in region for Non-Availability Zones. ,
Required: False ,
}
boolean ,
isSubscriptionRegionAccessAllowedForAz:
{
Description: Flag indicating whether the subscription have access in region for Availability Zones(Az). ,
Required: False ,
}
boolean ,
status:
{
Description: Enum to indicate current buildout status of the region. ,
Enum:
{
Uninitialized: No description available. ,
Initializing: No description available. ,
InternallyReady: No description available. ,
Online: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraResources_ListCassandraViews (new)
Description :  Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views
{
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 views and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an Azure Cosmos DB Cassandra view ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraView (new)
Description :  Gets the Cassandra view under an existing Azure Cosmos DB database account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}
{
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 ,
viewName:
{
Description: Cosmos DB view 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 view ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
options:
{
Required: False ,
}
string ,
}
,
}
CassandraResources_CreateUpdateCassandraView (new)
Description :  Create or update an Azure Cosmos DB Cassandra View
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}
{
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 ,
viewName:
{
Description: Cosmos DB view name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateCassandraViewParameters:
{
Description: The parameters to provide for the current Cassandra View. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update Azure Cosmos DB Cassandra view. ,
Required: True ,
}
{
resource:
{
Description: The standard JSON format of a Cassandra view ,
Required: True ,
}
{
id:
{
Description: Name of the Cosmos DB Cassandra view ,
Required: True ,
}
string ,
viewDefinition:
{
Description: View Definition of the Cosmos DB Cassandra view ,
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: False ,
}
{
throughput:
{
Description: Request Units per second. For example, "throughput": 10000. ,
Required: False ,
}
integer ,
autoscaleSettings:
{
Description: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. ,
Required: False ,
}
{
maxThroughput:
{
Description: Represents maximum throughput, the resource can scale up to. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}
{
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 ,
viewName:
{
Description: Cosmos DB view name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}
CassandraResources_GetCassandraViewThroughput (new)
Description :  Gets the RUs per second of the Cassandra view 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}/views/{viewName}/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 ,
viewName:
{
Description: Cosmos DB view 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_UpdateCassandraViewThroughput (new)
Description :  Update RUs per second of an Azure Cosmos DB Cassandra view
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/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 ,
viewName:
{
Description: Cosmos DB view 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 view. ,
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 ,
instantMaximumThroughput:
{
Description: The offer throughput value to instantly scale up without triggering splits ,
Required: False ,
}
string ,
softAllowedMaximumThroughput:
{
Description: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified ,
Required: False ,
}
string ,
throughputBuckets:
{
Description: Array of Throughput Bucket limits to be applied to the Cosmos DB container ,
Required: False ,
}
[
{
id:
{
Description: Represents the throughput bucket id ,
Format: int32 ,
Required: True ,
}
integer ,
maxThroughputPercentage:
{
Description: Represents maximum percentage throughput that can be used by the bucket ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/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 ,
viewName:
{
Description: Cosmos DB view name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraResources_MigrateCassandraViewToManualThroughput (new)
Description :  Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/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 ,
viewName:
{
Description: Cosmos DB view name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an Azure Cosmos DB resource throughput ,
Required: False ,
}
{
resource:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_Create (new)
Description :  Creates a Data Transfer Job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}
{
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 ,
jobName:
{
Description: Name of the Data Transfer Job ,
Required: True ,
}
string ,
jobCreateParameters:
{
Required: True ,
}
{
properties:
{
Description: Data Transfer Create Job Properties ,
Required: True ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_Get (new)
Description :  Get a Data Transfer Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}
{
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 ,
jobName:
{
Description: Name of the Data Transfer Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_Pause (new)
Description :  Pause a Data Transfer Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/pause
{
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 ,
jobName:
{
Description: Name of the Data Transfer Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_Resume (new)
Description :  Resumes a Data Transfer Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/resume
{
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 ,
jobName:
{
Description: Name of the Data Transfer Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_Cancel (new)
Description :  Cancels a Data Transfer Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/cancel
{
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 ,
jobName:
{
Description: Name of the Data Transfer Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_Complete (new)
Description :  Completes a Data Transfer Online Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/complete
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
jobName:
{
Description: Name of the Data Transfer Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
DataTransferJobs_ListByDatabaseAccount (new)
Description :  Get a list of Data Transfer jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs
{
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 Data Transfer jobs and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a DataTransfer Job ,
Required: False ,
}
{
jobName:
{
Description: Job Name ,
Required: False ,
}
string ,
source:
{
Description: Source DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
destination:
{
Description: Destination DataStore details ,
Required: True ,
}
{
component:
{
Enum:
{
CosmosDBCassandra: No description available. ,
CosmosDBMongo: No description available. ,
CosmosDBMongoVCore: No description available. ,
CosmosDBSql: No description available. ,
AzureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: Job Status ,
Required: False ,
}
string ,
processedCount:
{
Description: Processed Count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total Count. ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedUtcTime:
{
Description: Last Updated Time (ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
workerCount:
{
Description: Worker count ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Error response for Faulted job ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Total Duration of Job ,
Required: False ,
}
string ,
mode:
{
Description: Mode of job execution ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Data Transfer job list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Fleet_List (new)
Description :  Lists all the fleets under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/fleets
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of fleets and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleet_ListByResourceGroup (new)
Description :  Lists all the fleets under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: List of fleets and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleet_Get (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleet_Create (new)
Description :  Creates an Azure Cosmos DB fleet under a subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current fleet. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleet_Update (new)
Description :  Updates the properties of an existing Azure Cosmos DB Fleet.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current fleet. ,
Required: False ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to update Azure Cosmos DB fleet resource. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleet. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleet_Delete (new)
Description :  Deletes an existing Azure Cosmos DB Fleet.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetAnalytics_List (new)
Description :  Lists all the FleetAnalytics under a fleet.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of FleetAnalytics and their properties. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the FleetAnalytics. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationType:
{
Description: The type of the fleet analytics resource. ,
Enum:
{
StorageAccount: No description available. ,
FabricLakehouse: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationUri:
{
Description: The unique identifier of the fleet analytics resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetAnalytics_Get (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB FleetAnalytics under a fleet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics/{fleetAnalyticsName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetAnalyticsName:
{
Description: Cosmos DB fleetAnalytics name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the FleetAnalytics. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationType:
{
Description: The type of the fleet analytics resource. ,
Enum:
{
StorageAccount: No description available. ,
FabricLakehouse: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationUri:
{
Description: The unique identifier of the fleet analytics resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetAnalytics_Create (new)
Description :  Creates an Azure Cosmos DB FleetAnalytics under a fleet.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics/{fleetAnalyticsName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetAnalyticsName:
{
Description: Cosmos DB fleetAnalytics name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current FleetAnalytics. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the FleetAnalytics. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationType:
{
Description: The type of the fleet analytics resource. ,
Enum:
{
StorageAccount: No description available. ,
FabricLakehouse: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationUri:
{
Description: The unique identifier of the fleet analytics resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the FleetAnalytics. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationType:
{
Description: The type of the fleet analytics resource. ,
Enum:
{
StorageAccount: No description available. ,
FabricLakehouse: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationUri:
{
Description: The unique identifier of the fleet analytics resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the FleetAnalytics. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationType:
{
Description: The type of the fleet analytics resource. ,
Enum:
{
StorageAccount: No description available. ,
FabricLakehouse: No description available. ,
}
,
Required: False ,
}
enum ,
storageLocationUri:
{
Description: The unique identifier of the fleet analytics resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetAnalytics_Delete (new)
Description :  Deletes an existing Azure Cosmos DB FleetAnalytics.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics/{fleetAnalyticsName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetAnalyticsName:
{
Description: Cosmos DB fleetAnalytics name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleetspace_List (new)
Description :  Lists all the fleetspaces under a fleet.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of fleetspaces and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties to update Azure Cosmos DB Fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleetspace_Get (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties to update Azure Cosmos DB Fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleetspace_Create (new)
Description :  Creates an Azure Cosmos DB fleetspace under a fleet.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current fleetspace. ,
Required: True ,
}
{
properties:
{
Description: Properties to update Azure Cosmos DB Fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to update Azure Cosmos DB Fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties to update Azure Cosmos DB Fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleetspace_Update (new)
Description :  Update the properties of an existing Azure Cosmos DB fleetspace under a fleet.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current fleetspace. ,
Required: False ,
}
{
properties:
{
Description: Properties of the fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to update Azure Cosmos DB Fleetspace. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fleetspaceApiKind:
{
Description: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL' ,
Enum:
{
NoSQL: No description available. ,
}
,
Required: False ,
}
enum ,
throughputPoolConfiguration:
{
Description: Configuration for throughput pool in the fleetspace. ,
Required: False ,
}
{
minThroughput:
{
Description: Minimum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
maxThroughput:
{
Description: Maximum throughput for the pool. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceTier:
{
Description: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. ,
Enum:
{
GeneralPurpose: No description available. ,
BusinessCritical: No description available. ,
}
,
Required: False ,
}
enum ,
dataRegions:
{
Description: List of data regions assigned to the fleetspace. Eg [westus2] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleetspace_Delete (new)
Description :  Deletes an existing Azure Cosmos DB Fleetspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetspaceAccount_List (new)
Description :  Lists all the fleetspaces accounts under a fleetspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of global database accounts in a fleetspace and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
accountResourceIdentifier:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
accountLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetspaceAccount_Get (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
fleetspaceAccountName:
{
Description: Cosmos DB fleetspace account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
accountResourceIdentifier:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
accountLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetspaceAccount_Create (new)
Description :  Creates an Azure Cosmos DB fleetspace account under a fleetspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
fleetspaceAccountName:
{
Description: Cosmos DB fleetspace account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current fleetspace account. ,
Required: True ,
}
{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
accountResourceIdentifier:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
accountLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
accountResourceIdentifier:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
accountLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
accountResourceIdentifier:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
accountLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetspaceAccount_Delete (new)
Description :  Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
fleetspaceAccountName:
{
Description: Cosmos DB fleetspace account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_GetGremlinRoleDefinition (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions/{roleDefinitionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleDefinitionId:
{
Description: The GUID for the Role Definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Gremlin Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_CreateUpdateGremlinRoleDefinition (new)
Description :  Creates or updates an Azure Cosmos DB Gremlin Role Definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions/{roleDefinitionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleDefinitionId:
{
Description: The GUID for the Role Definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGremlinRoleDefinitionParameters:
{
Description: The properties required to create or update a Role Definition. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Gremlin Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Gremlin Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_DeleteGremlinRoleDefinition (new)
Description :  Deletes an existing Azure Cosmos DB Gremlin Role Definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions/{roleDefinitionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleDefinitionId:
{
Description: The GUID for the Role Definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_ListGremlinRoleDefinitions (new)
Description :  Retrieves the list of all Azure Cosmos DB Gremlin Role Definitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Role Definitions and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Definition. ,
Required: False ,
}
{
id:
{
Description: The path id for the Role Definition. ,
Required: False ,
}
string ,
roleName:
{
Description: A user-friendly name for the Role Definition. Must be unique for the database account. ,
Required: False ,
}
string ,
type:
{
Description: Indicates whether the Role Definition was built-in or user created. ,
Enum:
{
BuiltInRole: No description available. ,
CustomRole: No description available. ,
}
,
Required: False ,
}
enum ,
assignableScopes:
{
Description: A set of fully qualified Scopes at or below which Gremlin Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The set of operations allowed through this Role Definition. ,
Required: False ,
}
[
{
id:
{
Description: The id for the permission. ,
Required: False ,
}
string ,
dataActions:
{
Description: An array of data actions that are allowed. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: An array of data actions that are denied. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_GetGremlinRoleAssignment (new)
Description :  Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{roleAssignmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleAssignmentId:
{
Description: The GUID for the Role Assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Gremlin Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_CreateUpdateGremlinRoleAssignment (new)
Description :  Creates or updates an Azure Cosmos DB Gremlin Role Assignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{roleAssignmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleAssignmentId:
{
Description: The GUID for the Role Assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createUpdateGremlinRoleAssignmentParameters:
{
Description: The properties required to create or update a Role Assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Gremlin Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Gremlin Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_DeleteGremlinRoleAssignment (new)
Description :  Deletes an existing Azure Cosmos DB Gremlin Role Assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{roleAssignmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
roleAssignmentId:
{
Description: The GUID for the Role Assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GremlinResources_ListGremlinRoleAssignments (new)
Description :  Retrieves the list of all Azure Cosmos DB Gremlin Role Assignments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Role Assignments and their properties ,
Required: False ,
}
[
{
properties:
{
Description: Properties to create and update an Azure Cosmos DB Gremlin Role Assignment. ,
Required: False ,
}
{
roleDefinitionId:
{
Description: The unique identifier for the associated Role Definition. ,
Required: False ,
}
string ,
scope:
{
Description: The data plane resource path for which access is being granted through this Gremlin Role Assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraClusters_ListBySubscription (new)
Description :  List all managed Cassandra clusters in this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Container for the array of clusters. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_ListByResourceGroup (new)
Description :  List all managed Cassandra clusters in this resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: Container for the array of clusters. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_Get (new)
Description :  Get the properties of a managed Cassandra cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_Delete (new)
Description :  Deletes a managed Cassandra cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_CreateUpdate (new)
Description :  Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The properties specifying the desired state of the managed Cassandra cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_Update (new)
Description :  Updates some of the properties of a managed Cassandra cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Parameters to provide for specifying the managed Cassandra cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a managed Cassandra cluster. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
restoreFromBackupId:
{
Description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. ,
Required: False ,
}
string ,
delegatedManagementSubnetId:
{
Description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' ,
Required: False ,
}
string ,
cassandraVersion:
{
Description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. ,
Required: False ,
}
string ,
clusterNameOverride:
{
Description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. ,
Required: False ,
}
string ,
authenticationMethod:
{
Description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. ,
Enum:
{
None: No description available. ,
Cassandra: No description available. ,
Ldap: No description available. ,
}
,
Required: False ,
}
enum ,
initialCassandraAdminPassword:
{
Description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. ,
Required: False ,
}
string ,
prometheusEndpoint:
{
Description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
repairEnabled:
{
Description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. ,
Required: False ,
}
boolean ,
autoReplicate:
{
Description: The form of AutoReplicate that is being used by this cluster. ,
Enum:
{
None: No description available. ,
SystemKeyspaces: No description available. ,
AllKeyspaces: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertificates:
{
Description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalGossipCertificates:
{
Description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
gossipCertificates:
{
Description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. ,
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
externalSeedNodes:
{
Description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
seedNodes:
{
Description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
externalDataCenters:
{
Description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. ,
Required: False ,
}
[
string ,
]
,
hoursBetweenBackups:
{
Description: (Deprecated) Number of hours to wait between taking a backup of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
deallocated:
{
Description: Whether the cluster and associated data centers has been deallocated. ,
Required: False ,
}
boolean ,
cassandraAuditLoggingEnabled:
{
Description: Whether Cassandra audit logging is enabled ,
Required: False ,
}
boolean ,
clusterType:
{
Description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. ,
Enum:
{
Production: No description available. ,
NonProduction: No description available. ,
}
,
Required: False ,
}
enum ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
extensions:
{
Description: Extensions to be added or updated on cluster. ,
Required: False ,
}
[
string ,
]
,
backupSchedules:
{
Description: List of backup schedules that define when you want to back up your data. ,
Required: False ,
}
[
{
scheduleName:
{
Description: The unique identifier of backup schedule. ,
Required: False ,
}
string ,
cronExpression:
{
Description: The cron expression that defines when you want to back up your data. ,
Required: False ,
}
string ,
retentionInHours:
{
Description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scheduledEventStrategy:
{
Description: How the nodes in the cluster react to scheduled events ,
Enum:
{
Ignore: No description available. ,
StopAny: No description available. ,
StopByRack: No description available. ,
}
,
Required: False ,
}
enum ,
azureConnectionMethod:
{
Description: How to connect to the azure services needed for running the cluster ,
Enum:
{
None: No description available. ,
VPN: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkResourceId:
{
Description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_InvokeCommand (new)
Description :  Invoke a command like nodetool for cassandra maintenance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommand
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Specification which command to run where ,
Required: True ,
}
{
command:
{
Description: The command which should be run ,
Required: True ,
}
string ,
arguments:
{
Description: The arguments for the command to be run ,
Required: False ,
}
object ,
host:
{
Description: IP address of the cassandra host to run the command on ,
Required: True ,
}
string ,
cassandra-stop-start:
{
Description: If true, stops cassandra before executing the command and then start it again ,
Required: False ,
}
boolean ,
readwrite:
{
Description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
commandOutput:
{
Description: Output of the command. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_InvokeCommandAsync (new)
Description :  Invoke a command like nodetool for cassandra maintenance asynchronously
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommandAsync
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Specification which command to run where ,
Required: True ,
}
{
command:
{
Description: The command which should be run ,
Required: True ,
}
string ,
arguments:
{
Description: The arguments for the command to be run ,
Required: False ,
}
object ,
host:
{
Description: IP address of the cassandra host to run the command on ,
Required: True ,
}
string ,
cassandra-stop-start:
{
Description: If true, stops cassandra before executing the command and then start it again ,
Required: False ,
}
boolean ,
readWrite:
{
Description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
command:
{
Description: The command which should be run ,
Required: False ,
}
string ,
commandId:
{
Description: The unique id of command ,
Required: False ,
}
string ,
arguments:
{
Description: The arguments for the command to be run ,
Required: False ,
}
object ,
host:
{
Description: IP address of the cassandra host to run the command on ,
Required: False ,
}
string ,
isAdmin:
{
Description: Whether command has admin privileges ,
Required: False ,
}
boolean ,
cassandraStopStart:
{
Description: If true, stops cassandra before executing the command and then start it again ,
Required: False ,
}
boolean ,
readWrite:
{
Description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. ,
Required: False ,
}
boolean ,
result:
{
Description: Result output of the command. ,
Required: False ,
}
string ,
status:
{
Description: Status of the command. ,
Enum:
{
Done: No description available. ,
Running: No description available. ,
Enqueue: No description available. ,
Processing: No description available. ,
Finished: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
outputFile:
{
Description: The name of the file where the result is written. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CassandraClusters_ListCommand (new)
Description :  List all commands currently running on ring info
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Container for array of commands. ,
Required: False ,
}
[
{
command:
{
Description: The command which should be run ,
Required: False ,
}
string ,
commandId:
{
Description: The unique id of command ,
Required: False ,
}
string ,
arguments:
{
Description: The arguments for the command to be run ,
Required: False ,
}
object ,
host:
{
Description: IP address of the cassandra host to run the command on ,
Required: False ,
}
string ,
isAdmin:
{
Description: Whether command has admin privileges ,
Required: False ,
}
boolean ,
cassandraStopStart:
{
Description: If true, stops cassandra before executing the command and then start it again ,
Required: False ,
}
boolean ,
readWrite:
{
Description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. ,
Required: False ,
}
boolean ,
result:
{
Description: Result output of the command. ,
Required: False ,
}
string ,
status:
{
Description: Status of the command. ,
Enum:
{
Done: No description available. ,
Running: No description available. ,
Enqueue: No description available. ,
Processing: No description available. ,
Finished: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
outputFile:
{
Description: The name of the file where the result is written. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_GetCommandAsync (new)
Description :  Get details about a specified command that was run asynchronously.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands/{commandId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
commandId:
{
Description: Managed Cassandra cluster command id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
command:
{
Description: The command which should be run ,
Required: False ,
}
string ,
commandId:
{
Description: The unique id of command ,
Required: False ,
}
string ,
arguments:
{
Description: The arguments for the command to be run ,
Required: False ,
}
object ,
host:
{
Description: IP address of the cassandra host to run the command on ,
Required: False ,
}
string ,
isAdmin:
{
Description: Whether command has admin privileges ,
Required: False ,
}
boolean ,
cassandraStopStart:
{
Description: If true, stops cassandra before executing the command and then start it again ,
Required: False ,
}
boolean ,
readWrite:
{
Description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. ,
Required: False ,
}
boolean ,
result:
{
Description: Result output of the command. ,
Required: False ,
}
string ,
status:
{
Description: Status of the command. ,
Enum:
{
Done: No description available. ,
Running: No description available. ,
Enqueue: No description available. ,
Processing: No description available. ,
Finished: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
outputFile:
{
Description: The name of the file where the result is written. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_ListBackups (new)
Description :  List the backups of this cluster that are available to restore.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Container for array of backups. ,
Required: False ,
}
[
{
backupId:
{
Description: The unique identifier of backup. ,
Required: False ,
}
string ,
backupState:
{
Description: The current state of the backup. ,
Enum:
{
Initiated: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
backupStartTimestamp:
{
Description: The time at which the backup process begins. ,
Format: date-time ,
Required: False ,
}
string ,
backupStopTimestamp:
{
Description: The time at which the backup process ends. ,
Format: date-time ,
Required: False ,
}
string ,
backupExpiryTimestamp:
{
Description: The time at which the backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraClusters_GetBackup (new)
Description :  Get the properties of an individual backup of this cluster that is available to restore.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
backupId:
{
Description: Id of a restorable backup of a Cassandra cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
backupId:
{
Description: The unique identifier of backup. ,
Required: False ,
}
string ,
backupState:
{
Description: The current state of the backup. ,
Enum:
{
Initiated: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
backupStartTimestamp:
{
Description: The time at which the backup process begins. ,
Format: date-time ,
Required: False ,
}
string ,
backupStopTimestamp:
{
Description: The time at which the backup process ends. ,
Format: date-time ,
Required: False ,
}
string ,
backupExpiryTimestamp:
{
Description: The time at which the backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraDataCenters_List (new)
Description :  List all data centers in a particular managed Cassandra cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Container for array of data centers. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a managed Cassandra data center. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
dataCenterLocation:
{
Description: The region this data center should be created in. ,
Required: False ,
}
string ,
delegatedSubnetId:
{
Description: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. ,
Required: False ,
}
string ,
nodeCount:
{
Description: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
seedNodes:
{
Description: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
base64EncodedCassandraYamlFragment:
{
Description: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. ,
Required: False ,
}
string ,
managedDiskCustomerKeyUri:
{
Description: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. ,
Required: False ,
}
string ,
backupStorageCustomerKeyUri:
{
Description: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. ,
Required: False ,
}
string ,
sku:
{
Description: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 ,
Required: False ,
}
string ,
diskSku:
{
Description: Disk SKU used for data centers. Default value is P30. ,
Required: False ,
}
string ,
diskCapacity:
{
Description: Number of disks attached to each node. Default is 4. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityZone:
{
Description: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. ,
Required: False ,
}
boolean ,
authenticationMethodLdapProperties:
{
Description: Ldap authentication method properties. This feature is in preview. ,
Required: False ,
}
{
serverHostname:
{
Description: Hostname of the LDAP server. ,
Required: False ,
}
string ,
serverPort:
{
Description: Port of the LDAP server. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceUserDistinguishedName:
{
Description: Distinguished name of the look up user account, who can look up user details on authentication. ,
Required: False ,
}
string ,
serviceUserPassword:
{
Description: Password of the look up user. ,
Required: False ,
}
string ,
searchBaseDistinguishedName:
{
Description: Distinguished name of the object to start the recursive search of users from. ,
Required: False ,
}
string ,
searchFilterTemplate:
{
Description: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. ,
Required: False ,
}
string ,
serverCertificates:
{
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
connectionTimeoutInMs:
{
Description: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deallocated:
{
Description: Whether the data center has been deallocated. ,
Required: False ,
}
boolean ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
privateEndpointIpAddress:
{
Description: Ip of the VPN Endpoint for this data center. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraDataCenters_Get (new)
Description :  Get the properties of a managed Cassandra data center.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
dataCenterName:
{
Description: Data center name in a managed Cassandra cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a managed Cassandra data center. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
dataCenterLocation:
{
Description: The region this data center should be created in. ,
Required: False ,
}
string ,
delegatedSubnetId:
{
Description: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. ,
Required: False ,
}
string ,
nodeCount:
{
Description: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
seedNodes:
{
Description: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
base64EncodedCassandraYamlFragment:
{
Description: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. ,
Required: False ,
}
string ,
managedDiskCustomerKeyUri:
{
Description: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. ,
Required: False ,
}
string ,
backupStorageCustomerKeyUri:
{
Description: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. ,
Required: False ,
}
string ,
sku:
{
Description: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 ,
Required: False ,
}
string ,
diskSku:
{
Description: Disk SKU used for data centers. Default value is P30. ,
Required: False ,
}
string ,
diskCapacity:
{
Description: Number of disks attached to each node. Default is 4. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityZone:
{
Description: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. ,
Required: False ,
}
boolean ,
authenticationMethodLdapProperties:
{
Description: Ldap authentication method properties. This feature is in preview. ,
Required: False ,
}
{
serverHostname:
{
Description: Hostname of the LDAP server. ,
Required: False ,
}
string ,
serverPort:
{
Description: Port of the LDAP server. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceUserDistinguishedName:
{
Description: Distinguished name of the look up user account, who can look up user details on authentication. ,
Required: False ,
}
string ,
serviceUserPassword:
{
Description: Password of the look up user. ,
Required: False ,
}
string ,
searchBaseDistinguishedName:
{
Description: Distinguished name of the object to start the recursive search of users from. ,
Required: False ,
}
string ,
searchFilterTemplate:
{
Description: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. ,
Required: False ,
}
string ,
serverCertificates:
{
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
connectionTimeoutInMs:
{
Description: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deallocated:
{
Description: Whether the data center has been deallocated. ,
Required: False ,
}
boolean ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
privateEndpointIpAddress:
{
Description: Ip of the VPN Endpoint for this data center. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraDataCenters_Delete (new)
Description :  Delete a managed Cassandra data center.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
dataCenterName:
{
Description: Data center name in a managed Cassandra cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraDataCenters_CreateUpdate (new)
Description :  Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
dataCenterName:
{
Description: Data center name in a managed Cassandra cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Parameters specifying the managed Cassandra data center. ,
Required: True ,
}
{
properties:
{
Description: Properties of a managed Cassandra data center. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
dataCenterLocation:
{
Description: The region this data center should be created in. ,
Required: False ,
}
string ,
delegatedSubnetId:
{
Description: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. ,
Required: False ,
}
string ,
nodeCount:
{
Description: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
seedNodes:
{
Description: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
base64EncodedCassandraYamlFragment:
{
Description: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. ,
Required: False ,
}
string ,
managedDiskCustomerKeyUri:
{
Description: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. ,
Required: False ,
}
string ,
backupStorageCustomerKeyUri:
{
Description: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. ,
Required: False ,
}
string ,
sku:
{
Description: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 ,
Required: False ,
}
string ,
diskSku:
{
Description: Disk SKU used for data centers. Default value is P30. ,
Required: False ,
}
string ,
diskCapacity:
{
Description: Number of disks attached to each node. Default is 4. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityZone:
{
Description: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. ,
Required: False ,
}
boolean ,
authenticationMethodLdapProperties:
{
Description: Ldap authentication method properties. This feature is in preview. ,
Required: False ,
}
{
serverHostname:
{
Description: Hostname of the LDAP server. ,
Required: False ,
}
string ,
serverPort:
{
Description: Port of the LDAP server. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceUserDistinguishedName:
{
Description: Distinguished name of the look up user account, who can look up user details on authentication. ,
Required: False ,
}
string ,
serviceUserPassword:
{
Description: Password of the look up user. ,
Required: False ,
}
string ,
searchBaseDistinguishedName:
{
Description: Distinguished name of the object to start the recursive search of users from. ,
Required: False ,
}
string ,
searchFilterTemplate:
{
Description: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. ,
Required: False ,
}
string ,
serverCertificates:
{
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
connectionTimeoutInMs:
{
Description: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deallocated:
{
Description: Whether the data center has been deallocated. ,
Required: False ,
}
boolean ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
privateEndpointIpAddress:
{
Description: Ip of the VPN Endpoint for this data center. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a managed Cassandra data center. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
dataCenterLocation:
{
Description: The region this data center should be created in. ,
Required: False ,
}
string ,
delegatedSubnetId:
{
Description: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. ,
Required: False ,
}
string ,
nodeCount:
{
Description: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
seedNodes:
{
Description: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
base64EncodedCassandraYamlFragment:
{
Description: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. ,
Required: False ,
}
string ,
managedDiskCustomerKeyUri:
{
Description: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. ,
Required: False ,
}
string ,
backupStorageCustomerKeyUri:
{
Description: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. ,
Required: False ,
}
string ,
sku:
{
Description: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 ,
Required: False ,
}
string ,
diskSku:
{
Description: Disk SKU used for data centers. Default value is P30. ,
Required: False ,
}
string ,
diskCapacity:
{
Description: Number of disks attached to each node. Default is 4. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityZone:
{
Description: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. ,
Required: False ,
}
boolean ,
authenticationMethodLdapProperties:
{
Description: Ldap authentication method properties. This feature is in preview. ,
Required: False ,
}
{
serverHostname:
{
Description: Hostname of the LDAP server. ,
Required: False ,
}
string ,
serverPort:
{
Description: Port of the LDAP server. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceUserDistinguishedName:
{
Description: Distinguished name of the look up user account, who can look up user details on authentication. ,
Required: False ,
}
string ,
serviceUserPassword:
{
Description: Password of the look up user. ,
Required: False ,
}
string ,
searchBaseDistinguishedName:
{
Description: Distinguished name of the object to start the recursive search of users from. ,
Required: False ,
}
string ,
searchFilterTemplate:
{
Description: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. ,
Required: False ,
}
string ,
serverCertificates:
{
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
connectionTimeoutInMs:
{
Description: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deallocated:
{
Description: Whether the data center has been deallocated. ,
Required: False ,
}
boolean ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
privateEndpointIpAddress:
{
Description: Ip of the VPN Endpoint for this data center. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a managed Cassandra data center. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
dataCenterLocation:
{
Description: The region this data center should be created in. ,
Required: False ,
}
string ,
delegatedSubnetId:
{
Description: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. ,
Required: False ,
}
string ,
nodeCount:
{
Description: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
seedNodes:
{
Description: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address of this seed node. ,
Required: False ,
}
string ,
}
,
]
,
base64EncodedCassandraYamlFragment:
{
Description: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. ,
Required: False ,
}
string ,
managedDiskCustomerKeyUri:
{
Description: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. ,
Required: False ,
}
string ,
backupStorageCustomerKeyUri:
{
Description: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. ,
Required: False ,
}
string ,
sku:
{
Description: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 ,
Required: False ,
}
string ,
diskSku:
{
Description: Disk SKU used for data centers. Default value is P30. ,
Required: False ,
}
string ,
diskCapacity:
{
Description: Number of disks attached to each node. Default is 4. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityZone:
{
Description: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. ,
Required: False ,
}
boolean ,
authenticationMethodLdapProperties:
{
Description: Ldap authentication method properties. This feature is in preview. ,
Required: False ,
}
{
serverHostname:
{
Description: Hostname of the LDAP server. ,
Required: False ,
}
string ,
serverPort:
{
Description: Port of the LDAP server. ,
Format: int32 ,
Required: False ,
}
integer ,
serviceUserDistinguishedName:
{
Description: Distinguished name of the look up user account, who can look up user details on authentication. ,
Required: False ,
}
string ,
serviceUserPassword:
{
Description: Password of the look up user. ,
Required: False ,
}
string ,
searchBaseDistinguishedName:
{
Description: Distinguished name of the object to start the recursive search of users from. ,
Required: False ,
}
string ,
searchFilterTemplate:
{
Description: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. ,
Required: False ,
}
string ,
serverCertificates:
{
Required: False ,
}
[
{
pem:
{
Description: PEM formatted public key. ,
Required: False ,
}
string ,
}
,
]
,
connectionTimeoutInMs:
{
Description: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
deallocated:
{
Description: Whether the data center has been deallocated. ,
Required: False ,
}
boolean ,
provisionError:
{
Description: Error related to resource provisioning. ,
Required: False ,
}
{
code:
{
Description: The code of error that occurred. ,
Required: False ,
}
string ,
message:
{
Description: The message of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error. ,
Required: False ,
}
string ,
additionalErrorInfo:
{
Description: Additional information about the error. ,
Required: False ,
}
string ,
}
,
privateEndpointIpAddress:
{
Description: Ip of the VPN Endpoint for this data center. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error Response. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CassandraDataCenters_Update (new)
Description :  Update some of the properties of a managed Cassandra data center.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Managed Cassandra cluster name. ,
Required: True ,
}
string ,
dataCenterName:
{
Description: Data center name in a managed Cassandra cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Parameters to provide for specifying the managed Cassandra data center. ,
Required: True ,
}
{
properties:
{
Description: Properties of a managed Cassandra data center. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the resource at the time the operation was called. ,
Enum:
{
Creating: