CassandraResources interface

Interface representing a CassandraResources.

Methods

beginCreateUpdateCassandraKeyspace(string, string, string, CassandraKeyspaceCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams)

Create or update an Azure Cosmos DB Cassandra keyspace

beginCreateUpdateCassandraKeyspaceAndWait(string, string, string, CassandraKeyspaceCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams)

Create or update an Azure Cosmos DB Cassandra keyspace

beginCreateUpdateCassandraTable(string, string, string, string, CassandraTableCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraTableOptionalParams)

Create or update an Azure Cosmos DB Cassandra Table

beginCreateUpdateCassandraTableAndWait(string, string, string, string, CassandraTableCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraTableOptionalParams)

Create or update an Azure Cosmos DB Cassandra Table

beginCreateUpdateCassandraView(string, string, string, string, CassandraViewCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraViewOptionalParams)

Create or update an Azure Cosmos DB Cassandra View

beginCreateUpdateCassandraViewAndWait(string, string, string, string, CassandraViewCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraViewOptionalParams)

Create or update an Azure Cosmos DB Cassandra View

beginDeleteCassandraKeyspace(string, string, string, CassandraResourcesDeleteCassandraKeyspaceOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra keyspace.

beginDeleteCassandraKeyspaceAndWait(string, string, string, CassandraResourcesDeleteCassandraKeyspaceOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra keyspace.

beginDeleteCassandraTable(string, string, string, string, CassandraResourcesDeleteCassandraTableOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra table.

beginDeleteCassandraTableAndWait(string, string, string, string, CassandraResourcesDeleteCassandraTableOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra table.

beginDeleteCassandraView(string, string, string, string, CassandraResourcesDeleteCassandraViewOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra view.

beginDeleteCassandraViewAndWait(string, string, string, string, CassandraResourcesDeleteCassandraViewOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra view.

beginMigrateCassandraKeyspaceToAutoscale(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale

beginMigrateCassandraKeyspaceToAutoscaleAndWait(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale

beginMigrateCassandraKeyspaceToManualThroughput(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput

beginMigrateCassandraKeyspaceToManualThroughputAndWait(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput

beginMigrateCassandraTableToAutoscale(string, string, string, string, CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale

beginMigrateCassandraTableToAutoscaleAndWait(string, string, string, string, CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale

beginMigrateCassandraTableToManualThroughput(string, string, string, string, CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput

beginMigrateCassandraTableToManualThroughputAndWait(string, string, string, string, CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput

beginMigrateCassandraViewToAutoscale(string, string, string, string, CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale

beginMigrateCassandraViewToAutoscaleAndWait(string, string, string, string, CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale

beginMigrateCassandraViewToManualThroughput(string, string, string, string, CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput

beginMigrateCassandraViewToManualThroughputAndWait(string, string, string, string, CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput

beginUpdateCassandraKeyspaceThroughput(string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

beginUpdateCassandraKeyspaceThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

beginUpdateCassandraTableThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraTableThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra table

beginUpdateCassandraTableThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraTableThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra table

beginUpdateCassandraViewThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraViewThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra view

beginUpdateCassandraViewThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraViewThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra view

getCassandraKeyspace(string, string, string, CassandraResourcesGetCassandraKeyspaceOptionalParams)

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

getCassandraKeyspaceThroughput(string, string, string, CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams)

Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.

getCassandraTable(string, string, string, string, CassandraResourcesGetCassandraTableOptionalParams)

Gets the Cassandra table under an existing Azure Cosmos DB database account.

getCassandraTableThroughput(string, string, string, string, CassandraResourcesGetCassandraTableThroughputOptionalParams)

Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.

getCassandraView(string, string, string, string, CassandraResourcesGetCassandraViewOptionalParams)

Gets the Cassandra view under an existing Azure Cosmos DB database account.

getCassandraViewThroughput(string, string, string, string, CassandraResourcesGetCassandraViewThroughputOptionalParams)

Gets the RUs per second of the Cassandra view under an existing Azure Cosmos DB database account with the provided name.

listCassandraKeyspaces(string, string, CassandraResourcesListCassandraKeyspacesOptionalParams)

Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

listCassandraTables(string, string, string, CassandraResourcesListCassandraTablesOptionalParams)

Lists the Cassandra table under an existing Azure Cosmos DB database account.

listCassandraViews(string, string, string, CassandraResourcesListCassandraViewsOptionalParams)

Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.

Method Details

beginCreateUpdateCassandraKeyspace(string, string, string, CassandraKeyspaceCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams)

Create or update an Azure Cosmos DB Cassandra keyspace

function beginCreateUpdateCassandraKeyspace(resourceGroupName: string, accountName: string, keyspaceName: string, createUpdateCassandraKeyspaceParameters: CassandraKeyspaceCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams): Promise<SimplePollerLike<OperationState<CassandraKeyspaceGetResults>, CassandraKeyspaceGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

createUpdateCassandraKeyspaceParameters
CassandraKeyspaceCreateUpdateParameters

The parameters to provide for the current Cassandra keyspace.

Returns

beginCreateUpdateCassandraKeyspaceAndWait(string, string, string, CassandraKeyspaceCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams)

Create or update an Azure Cosmos DB Cassandra keyspace

function beginCreateUpdateCassandraKeyspaceAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, createUpdateCassandraKeyspaceParameters: CassandraKeyspaceCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams): Promise<CassandraKeyspaceGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

createUpdateCassandraKeyspaceParameters
CassandraKeyspaceCreateUpdateParameters

The parameters to provide for the current Cassandra keyspace.

Returns

beginCreateUpdateCassandraTable(string, string, string, string, CassandraTableCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraTableOptionalParams)

Create or update an Azure Cosmos DB Cassandra Table

function beginCreateUpdateCassandraTable(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, createUpdateCassandraTableParameters: CassandraTableCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraTableOptionalParams): Promise<SimplePollerLike<OperationState<CassandraTableGetResults>, CassandraTableGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

createUpdateCassandraTableParameters
CassandraTableCreateUpdateParameters

The parameters to provide for the current Cassandra Table.

Returns

beginCreateUpdateCassandraTableAndWait(string, string, string, string, CassandraTableCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraTableOptionalParams)

Create or update an Azure Cosmos DB Cassandra Table

function beginCreateUpdateCassandraTableAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, createUpdateCassandraTableParameters: CassandraTableCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraTableOptionalParams): Promise<CassandraTableGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

createUpdateCassandraTableParameters
CassandraTableCreateUpdateParameters

The parameters to provide for the current Cassandra Table.

Returns

beginCreateUpdateCassandraView(string, string, string, string, CassandraViewCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraViewOptionalParams)

Create or update an Azure Cosmos DB Cassandra View

function beginCreateUpdateCassandraView(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, createUpdateCassandraViewParameters: CassandraViewCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraViewOptionalParams): Promise<SimplePollerLike<OperationState<CassandraViewGetResults>, CassandraViewGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

createUpdateCassandraViewParameters
CassandraViewCreateUpdateParameters

The parameters to provide for the current Cassandra View.

Returns

beginCreateUpdateCassandraViewAndWait(string, string, string, string, CassandraViewCreateUpdateParameters, CassandraResourcesCreateUpdateCassandraViewOptionalParams)

Create or update an Azure Cosmos DB Cassandra View

function beginCreateUpdateCassandraViewAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, createUpdateCassandraViewParameters: CassandraViewCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraViewOptionalParams): Promise<CassandraViewGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

createUpdateCassandraViewParameters
CassandraViewCreateUpdateParameters

The parameters to provide for the current Cassandra View.

Returns

beginDeleteCassandraKeyspace(string, string, string, CassandraResourcesDeleteCassandraKeyspaceOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra keyspace.

function beginDeleteCassandraKeyspace(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesDeleteCassandraKeyspaceOptionalParams): Promise<SimplePollerLike<OperationState<CassandraResourcesDeleteCassandraKeyspaceHeaders>, CassandraResourcesDeleteCassandraKeyspaceHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

beginDeleteCassandraKeyspaceAndWait(string, string, string, CassandraResourcesDeleteCassandraKeyspaceOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra keyspace.

function beginDeleteCassandraKeyspaceAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesDeleteCassandraKeyspaceOptionalParams): Promise<CassandraResourcesDeleteCassandraKeyspaceHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

beginDeleteCassandraTable(string, string, string, string, CassandraResourcesDeleteCassandraTableOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra table.

function beginDeleteCassandraTable(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesDeleteCassandraTableOptionalParams): Promise<SimplePollerLike<OperationState<CassandraResourcesDeleteCassandraTableHeaders>, CassandraResourcesDeleteCassandraTableHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

beginDeleteCassandraTableAndWait(string, string, string, string, CassandraResourcesDeleteCassandraTableOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra table.

function beginDeleteCassandraTableAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesDeleteCassandraTableOptionalParams): Promise<CassandraResourcesDeleteCassandraTableHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

beginDeleteCassandraView(string, string, string, string, CassandraResourcesDeleteCassandraViewOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra view.

function beginDeleteCassandraView(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesDeleteCassandraViewOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

options
CassandraResourcesDeleteCassandraViewOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteCassandraViewAndWait(string, string, string, string, CassandraResourcesDeleteCassandraViewOptionalParams)

Deletes an existing Azure Cosmos DB Cassandra view.

function beginDeleteCassandraViewAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesDeleteCassandraViewOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

options
CassandraResourcesDeleteCassandraViewOptionalParams

The options parameters.

Returns

Promise<void>

beginMigrateCassandraKeyspaceToAutoscale(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale

function beginMigrateCassandraKeyspaceToAutoscale(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

beginMigrateCassandraKeyspaceToAutoscaleAndWait(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale

function beginMigrateCassandraKeyspaceToAutoscaleAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

beginMigrateCassandraKeyspaceToManualThroughput(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput

function beginMigrateCassandraKeyspaceToManualThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

beginMigrateCassandraKeyspaceToManualThroughputAndWait(string, string, string, CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput

function beginMigrateCassandraKeyspaceToManualThroughputAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

beginMigrateCassandraTableToAutoscale(string, string, string, string, CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale

function beginMigrateCassandraTableToAutoscale(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

beginMigrateCassandraTableToAutoscaleAndWait(string, string, string, string, CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale

function beginMigrateCassandraTableToAutoscaleAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

beginMigrateCassandraTableToManualThroughput(string, string, string, string, CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput

function beginMigrateCassandraTableToManualThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

beginMigrateCassandraTableToManualThroughputAndWait(string, string, string, string, CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput

function beginMigrateCassandraTableToManualThroughputAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

beginMigrateCassandraViewToAutoscale(string, string, string, string, CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale

function beginMigrateCassandraViewToAutoscale(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

Returns

beginMigrateCassandraViewToAutoscaleAndWait(string, string, string, string, CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale

function beginMigrateCassandraViewToAutoscaleAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

Returns

beginMigrateCassandraViewToManualThroughput(string, string, string, string, CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput

function beginMigrateCassandraViewToManualThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

Returns

beginMigrateCassandraViewToManualThroughputAndWait(string, string, string, string, CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput

function beginMigrateCassandraViewToManualThroughputAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

Returns

beginUpdateCassandraKeyspaceThroughput(string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

function beginUpdateCassandraKeyspaceThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Cassandra Keyspace.

Returns

beginUpdateCassandraKeyspaceThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

function beginUpdateCassandraKeyspaceThroughputAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Cassandra Keyspace.

Returns

beginUpdateCassandraTableThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraTableThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra table

function beginUpdateCassandraTableThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraTableThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Cassandra table.

Returns

beginUpdateCassandraTableThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraTableThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra table

function beginUpdateCassandraTableThroughputAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Cassandra table.

Returns

beginUpdateCassandraViewThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraViewThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra view

function beginUpdateCassandraViewThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraViewThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Cassandra view.

Returns

beginUpdateCassandraViewThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, CassandraResourcesUpdateCassandraViewThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Cassandra view

function beginUpdateCassandraViewThroughputAndWait(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraViewThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Cassandra view.

Returns

getCassandraKeyspace(string, string, string, CassandraResourcesGetCassandraKeyspaceOptionalParams)

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

function getCassandraKeyspace(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesGetCassandraKeyspaceOptionalParams): Promise<CassandraKeyspaceGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

getCassandraKeyspaceThroughput(string, string, string, CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams)

Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.

function getCassandraKeyspaceThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

Returns

getCassandraTable(string, string, string, string, CassandraResourcesGetCassandraTableOptionalParams)

Gets the Cassandra table under an existing Azure Cosmos DB database account.

function getCassandraTable(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesGetCassandraTableOptionalParams): Promise<CassandraTableGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

options
CassandraResourcesGetCassandraTableOptionalParams

The options parameters.

Returns

getCassandraTableThroughput(string, string, string, string, CassandraResourcesGetCassandraTableThroughputOptionalParams)

Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.

function getCassandraTableThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesGetCassandraTableThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

tableName

string

Cosmos DB table name.

Returns

getCassandraView(string, string, string, string, CassandraResourcesGetCassandraViewOptionalParams)

Gets the Cassandra view under an existing Azure Cosmos DB database account.

function getCassandraView(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesGetCassandraViewOptionalParams): Promise<CassandraViewGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

options
CassandraResourcesGetCassandraViewOptionalParams

The options parameters.

Returns

getCassandraViewThroughput(string, string, string, string, CassandraResourcesGetCassandraViewThroughputOptionalParams)

Gets the RUs per second of the Cassandra view under an existing Azure Cosmos DB database account with the provided name.

function getCassandraViewThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesGetCassandraViewThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

viewName

string

Cosmos DB view name.

Returns

listCassandraKeyspaces(string, string, CassandraResourcesListCassandraKeyspacesOptionalParams)

Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

function listCassandraKeyspaces(resourceGroupName: string, accountName: string, options?: CassandraResourcesListCassandraKeyspacesOptionalParams): PagedAsyncIterableIterator<CassandraKeyspaceGetResults, CassandraKeyspaceGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

listCassandraTables(string, string, string, CassandraResourcesListCassandraTablesOptionalParams)

Lists the Cassandra table under an existing Azure Cosmos DB database account.

function listCassandraTables(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesListCassandraTablesOptionalParams): PagedAsyncIterableIterator<CassandraTableGetResults, CassandraTableGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

options
CassandraResourcesListCassandraTablesOptionalParams

The options parameters.

Returns

listCassandraViews(string, string, string, CassandraResourcesListCassandraViewsOptionalParams)

Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.

function listCassandraViews(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesListCassandraViewsOptionalParams): PagedAsyncIterableIterator<CassandraViewGetResults, CassandraViewGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

keyspaceName

string

Cosmos DB keyspace name.

options
CassandraResourcesListCassandraViewsOptionalParams

The options parameters.

Returns