Cassandra Resources - Update Cassandra View Throughput

Service:

Cosmos DB Resource Provider

API Version:

2021-11-15-preview

Update RUs per second of an Azure Cosmos DB Cassandra view

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default?api-version=2021-11-15-preview

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	Cosmos DB database account name. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
keyspaceName	path	True	string	Cosmos DB keyspace name.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
viewName	path	True	string	Cosmos DB view name.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.resource	True	ThroughputSettingsResource	The standard JSON format of a resource throughput
identity		ManagedServiceIdentity	Identity for the resource.
location		string	The location of the resource group to which the resource belongs.
tags		object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

Responses

Name	Type	Description
200 OK	ThroughputSettingsGetResults	The RUs per second of the Cassandra view update operation was completed successfully.
202 Accepted		The RUs per second of the Cassandra view update operation will complete asynchronously.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBCassandraViewThroughputUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspacename/views/viewname/throughputSettings/default?api-version=2021-11-15-preview

{
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400
    }
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/views/viewName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings",
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true"
    }
  }
}

Status code:

202

Definitions

AutoscaleSettingsResource	Cosmos DB provisioned throughput settings object
AutoUpgradePolicyResource	Cosmos DB resource auto-upgrade policy
ManagedServiceIdentity	Identity for the resource.
Resource
ResourceIdentityType	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.
ThroughputPolicyResource	Cosmos DB resource throughput policy
ThroughputSettingsGetResults	An Azure Cosmos DB resource throughput.
ThroughputSettingsResource	Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.
ThroughputSettingsUpdateParameters	Parameters to update Cosmos DB resource throughput.
UserAssignedIdentities	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}'.

AutoscaleSettingsResource

Cosmos DB provisioned throughput settings object

Name	Type	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB resource auto-upgrade policy
maxThroughput	integer	Represents maximum throughput container can scale up to.
targetMaxThroughput	integer	Represents target maximum throughput container can scale up to once offer is no longer in pending state.

AutoUpgradePolicyResource

Cosmos DB resource auto-upgrade policy

Name	Type	Description
throughputPolicy	ThroughputPolicyResource	Represents throughput policy which service must adhere to for auto-upgrade

ManagedServiceIdentity

Identity for the resource.

Name	Type	Description
principalId	string	The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type	ResourceIdentityType	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.
userAssignedIdentities	UserAssignedIdentities	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}'.

Resource

Name	Type	Description
_etag	string	A system generated property representing the resource etag required for optimistic concurrency control.
_rid	string	A system generated property. A unique identifier.
_ts	number	A system generated property that denotes the last updated timestamp of the resource.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.
minimumThroughput	string	The minimum throughput of the resource
offerReplacePending	string	The throughput replace is pending
throughput	integer	Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

ResourceIdentityType

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.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ThroughputPolicyResource

Cosmos DB resource throughput policy

Name	Type	Description
incrementPercent	integer	Represents the percentage by which throughput can increase every time throughput policy kicks in.
isEnabled	boolean	Determines whether the ThroughputPolicy is active or not

ThroughputSettingsGetResults

An Azure Cosmos DB resource throughput.

Name	Type	Description
id	string	The unique resource identifier of the ARM resource.
identity	ManagedServiceIdentity	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
name	string	The name of the ARM resource.
properties.resource	Resource
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of Azure resource.

ThroughputSettingsResource

Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Name	Type	Description
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.
minimumThroughput	string	The minimum throughput of the resource
offerReplacePending	string	The throughput replace is pending
throughput	integer	Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

ThroughputSettingsUpdateParameters

Parameters to update Cosmos DB resource throughput.

Name	Type	Description
id	string	The unique resource identifier of the ARM resource.
identity	ManagedServiceIdentity	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
name	string	The name of the ARM resource.
properties.resource	ThroughputSettingsResource	The standard JSON format of a resource throughput
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of Azure resource.

UserAssignedIdentities

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}'.

Name	Type	Description