Sign in

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

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

Path parameters

resourceGroupNamestring required

Name of an Azure resource group.

accountNamestring required

Cosmos DB database account name.

Query parameters

api-versionstring required

Version of the API to be used with the client request. The current version is 2019-08-01.

Parameters

../../../../../common-types/resource-management/v1/types.json#/components/parameters/SubscriptionIdParameter — unresolved $ref

Request body

tagsTags

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".

locationstring

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

Response

The database account update operation will complete asynchronously.

idstring

The unique resource identifier of the ARM resource.

namestring

The name of the ARM resource.

typestring

The type of Azure resource.

locationstring

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

tagsTags

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".

Changes

Changed in 2 of the 11 revisions of this API.11

  • 2019-08-0133b0524b6a011See the full diff
    • ●

      deleted the path request parameter subscriptionId

      request-parameter-removed

  • 2019-08-011661781a93371See the full diff
    • ○

      api operation id DatabaseAccounts_Patch removed and replaced with DatabaseAccounts_Update

      api-operation-id-removed