CassandraResources | @azure/arm-cosmosdb

Interface representing a CassandraResources.

Hierarchy

CassandraResources

Implemented by

CassandraResourcesImpl

Index

Methods

beginCreateUpdateCassandraKeyspace

beginCreateUpdateCassandraKeyspace(resourceGroupName: string, accountName: string, keyspaceName: string, createUpdateCassandraKeyspaceParameters: CassandraKeyspaceCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraKeyspaceResponse>, CassandraResourcesCreateUpdateCassandraKeyspaceResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:126
Create or update an Azure Cosmos DB Cassandra keyspace

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.
- Optional options: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraKeyspaceResponse>, CassandraResourcesCreateUpdateCassandraKeyspaceResponse>>

beginCreateUpdateCassandraKeyspaceAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:149
Create or update an Azure Cosmos DB Cassandra keyspace

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.
- Optional options: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesCreateUpdateCassandraKeyspaceResponse>

beginCreateUpdateCassandraTable

beginCreateUpdateCassandraTable(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, createUpdateCassandraTableParameters: CassandraTableCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraTableOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraTableResponse>, CassandraResourcesCreateUpdateCassandraTableResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:328
Create or update an Azure Cosmos DB Cassandra Table

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.
- Optional options: CassandraResourcesCreateUpdateCassandraTableOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraTableResponse>, CassandraResourcesCreateUpdateCassandraTableResponse>>

beginCreateUpdateCassandraTableAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:351
Create or update an Azure Cosmos DB Cassandra Table

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.
- Optional options: CassandraResourcesCreateUpdateCassandraTableOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesCreateUpdateCassandraTableResponse>

beginCreateUpdateCassandraView

beginCreateUpdateCassandraView(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, createUpdateCassandraViewParameters: CassandraViewCreateUpdateParameters, options?: CassandraResourcesCreateUpdateCassandraViewOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraViewResponse>, CassandraResourcesCreateUpdateCassandraViewResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:546
Create or update an Azure Cosmos DB Cassandra View

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.
- Optional options: CassandraResourcesCreateUpdateCassandraViewOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraViewResponse>, CassandraResourcesCreateUpdateCassandraViewResponse>>

beginCreateUpdateCassandraViewAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:568
Create or update an Azure Cosmos DB Cassandra View

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.
- Optional options: CassandraResourcesCreateUpdateCassandraViewOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesCreateUpdateCassandraViewResponse>

beginDeleteCassandraKeyspace

beginDeleteCassandraKeyspace(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesDeleteCassandraKeyspaceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cassandraResources.ts:163
Deletes an existing Azure Cosmos DB Cassandra keyspace.

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.
- Optional options: CassandraResourcesDeleteCassandraKeyspaceOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCassandraKeyspaceAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:176
Deletes an existing Azure Cosmos DB Cassandra keyspace.

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.
- Optional options: CassandraResourcesDeleteCassandraKeyspaceOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteCassandraTable

beginDeleteCassandraTable(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesDeleteCassandraTableOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cassandraResources.ts:367
Deletes an existing Azure Cosmos DB Cassandra table.

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.
- Optional options: CassandraResourcesDeleteCassandraTableOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCassandraTableAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:382
Deletes an existing Azure Cosmos DB Cassandra table.

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.
- Optional options: CassandraResourcesDeleteCassandraTableOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteCassandraView

beginDeleteCassandraView(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesDeleteCassandraViewOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cassandraResources.ts:584
Deletes an existing Azure Cosmos DB Cassandra view.

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.
- Optional options: CassandraResourcesDeleteCassandraViewOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCassandraViewAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:599
Deletes an existing Azure Cosmos DB Cassandra view.

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.
- Optional options: CassandraResourcesDeleteCassandraViewOptionalParams
  
  The options parameters.
Returns Promise<void>

beginMigrateCassandraKeyspaceToAutoscale

beginMigrateCassandraKeyspaceToAutoscale(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraKeyspaceToAutoscaleResponse>, CassandraResourcesMigrateCassandraKeyspaceToAutoscaleResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:242
Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale

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.
- Optional options: CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraKeyspaceToAutoscaleResponse>, CassandraResourcesMigrateCassandraKeyspaceToAutoscaleResponse>>

beginMigrateCassandraKeyspaceToAutoscaleAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:262
Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale

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.
- Optional options: CassandraResourcesMigrateCassandraKeyspaceToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesMigrateCassandraKeyspaceToAutoscaleResponse>

beginMigrateCassandraKeyspaceToManualThroughput

beginMigrateCassandraKeyspaceToManualThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, options?: CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraKeyspaceToManualThroughputResponse>, CassandraResourcesMigrateCassandraKeyspaceToManualThroughputResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:275
Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput

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.
- Optional options: CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraKeyspaceToManualThroughputResponse>, CassandraResourcesMigrateCassandraKeyspaceToManualThroughputResponse>>

beginMigrateCassandraKeyspaceToManualThroughputAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:295
Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput

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.
- Optional options: CassandraResourcesMigrateCassandraKeyspaceToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesMigrateCassandraKeyspaceToManualThroughputResponse>

beginMigrateCassandraTableToAutoscale

beginMigrateCassandraTableToAutoscale(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraTableToAutoscaleResponse>, CassandraResourcesMigrateCassandraTableToAutoscaleResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:456
Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale

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.
- Optional options: CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraTableToAutoscaleResponse>, CassandraResourcesMigrateCassandraTableToAutoscaleResponse>>

beginMigrateCassandraTableToAutoscaleAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:478
Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale

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.
- Optional options: CassandraResourcesMigrateCassandraTableToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesMigrateCassandraTableToAutoscaleResponse>

beginMigrateCassandraTableToManualThroughput

beginMigrateCassandraTableToManualThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, options?: CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraTableToManualThroughputResponse>, CassandraResourcesMigrateCassandraTableToManualThroughputResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:493
Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput

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.
- Optional options: CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraTableToManualThroughputResponse>, CassandraResourcesMigrateCassandraTableToManualThroughputResponse>>

beginMigrateCassandraTableToManualThroughputAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:515
Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput

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.
- Optional options: CassandraResourcesMigrateCassandraTableToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesMigrateCassandraTableToManualThroughputResponse>

beginMigrateCassandraViewToAutoscale

beginMigrateCassandraViewToAutoscale(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraViewToAutoscaleResponse>, CassandraResourcesMigrateCassandraViewToAutoscaleResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:673
Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale

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.
- Optional options: CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraViewToAutoscaleResponse>, CassandraResourcesMigrateCassandraViewToAutoscaleResponse>>

beginMigrateCassandraViewToAutoscaleAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:695
Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale

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.
- Optional options: CassandraResourcesMigrateCassandraViewToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesMigrateCassandraViewToAutoscaleResponse>

beginMigrateCassandraViewToManualThroughput

beginMigrateCassandraViewToManualThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, options?: CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraViewToManualThroughputResponse>, CassandraResourcesMigrateCassandraViewToManualThroughputResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:710
Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput

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.
- Optional options: CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesMigrateCassandraViewToManualThroughputResponse>, CassandraResourcesMigrateCassandraViewToManualThroughputResponse>>

beginMigrateCassandraViewToManualThroughputAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:732
Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput

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.
- Optional options: CassandraResourcesMigrateCassandraViewToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesMigrateCassandraViewToManualThroughputResponse>

beginUpdateCassandraKeyspaceThroughput

beginUpdateCassandraKeyspaceThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesUpdateCassandraKeyspaceThroughputResponse>, CassandraResourcesUpdateCassandraKeyspaceThroughputResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:205
Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

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.
- Optional options: CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesUpdateCassandraKeyspaceThroughputResponse>, CassandraResourcesUpdateCassandraKeyspaceThroughputResponse>>

beginUpdateCassandraKeyspaceThroughputAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:228
Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

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.
- Optional options: CassandraResourcesUpdateCassandraKeyspaceThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesUpdateCassandraKeyspaceThroughputResponse>

beginUpdateCassandraTableThroughput

beginUpdateCassandraTableThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, tableName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraTableThroughputOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesUpdateCassandraTableThroughputResponse>, CassandraResourcesUpdateCassandraTableThroughputResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:415
Update RUs per second of an Azure Cosmos DB Cassandra table

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.
- Optional options: CassandraResourcesUpdateCassandraTableThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesUpdateCassandraTableThroughputResponse>, CassandraResourcesUpdateCassandraTableThroughputResponse>>

beginUpdateCassandraTableThroughputAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:440
Update RUs per second of an Azure Cosmos DB Cassandra table

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.
- Optional options: CassandraResourcesUpdateCassandraTableThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesUpdateCassandraTableThroughputResponse>

beginUpdateCassandraViewThroughput

beginUpdateCassandraViewThroughput(resourceGroupName: string, accountName: string, keyspaceName: string, viewName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: CassandraResourcesUpdateCassandraViewThroughputOptionalParams): Promise<PollerLike<PollOperationState<CassandraResourcesUpdateCassandraViewThroughputResponse>, CassandraResourcesUpdateCassandraViewThroughputResponse>>

- Defined in operationsInterfaces/cassandraResources.ts:632
Update RUs per second of an Azure Cosmos DB Cassandra view

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.
- Optional options: CassandraResourcesUpdateCassandraViewThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraResourcesUpdateCassandraViewThroughputResponse>, CassandraResourcesUpdateCassandraViewThroughputResponse>>

beginUpdateCassandraViewThroughputAndWait

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

- Defined in operationsInterfaces/cassandraResources.ts:657
Update RUs per second of an Azure Cosmos DB Cassandra view

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.
- Optional options: CassandraResourcesUpdateCassandraViewThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesUpdateCassandraViewThroughputResponse>

getCassandraKeyspace

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

- Defined in operationsInterfaces/cassandraResources.ts:111
Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: CassandraResourcesGetCassandraKeyspaceOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesGetCassandraKeyspaceResponse>

getCassandraKeyspaceThroughput

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

- Defined in operationsInterfaces/cassandraResources.ts:190
Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: CassandraResourcesGetCassandraKeyspaceThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesGetCassandraKeyspaceThroughputResponse>

getCassandraTable

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

- Defined in operationsInterfaces/cassandraResources.ts:311
Gets the Cassandra table under an existing Azure Cosmos DB database account.

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.
- Optional options: CassandraResourcesGetCassandraTableOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesGetCassandraTableResponse>

getCassandraTableThroughput

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

- Defined in operationsInterfaces/cassandraResources.ts:398
Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: CassandraResourcesGetCassandraTableThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesGetCassandraTableThroughputResponse>

getCassandraView

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

- Defined in operationsInterfaces/cassandraResources.ts:530
Gets the Cassandra view under an existing Azure Cosmos DB database account.

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.
- Optional options: CassandraResourcesGetCassandraViewOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesGetCassandraViewResponse>

getCassandraViewThroughput

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

- Defined in operationsInterfaces/cassandraResources.ts:615
Gets the RUs per second of the Cassandra view under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: CassandraResourcesGetCassandraViewThroughputOptionalParams
  
  The options parameters.
Returns Promise<CassandraResourcesGetCassandraViewThroughputResponse>

listCassandraKeyspaces

listCassandraKeyspaces(resourceGroupName: string, accountName: string, options?: CassandraResourcesListCassandraKeyspacesOptionalParams): PagedAsyncIterableIterator<CassandraKeyspaceGetResults>

- Defined in operationsInterfaces/cassandraResources.ts:72
Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: CassandraResourcesListCassandraKeyspacesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CassandraKeyspaceGetResults>

listCassandraTables

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

- Defined in operationsInterfaces/cassandraResources.ts:84
Lists the Cassandra table under an existing Azure Cosmos DB database account.

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.
- Optional options: CassandraResourcesListCassandraTablesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CassandraTableGetResults>

listCassandraViews

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

- Defined in operationsInterfaces/cassandraResources.ts:97
Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.

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.
- Optional options: CassandraResourcesListCassandraViewsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CassandraViewGetResults>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateUpdateCassandraKeyspace

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

createUpdateCassandraKeyspaceParameters: CassandraKeyspaceCreateUpdateParameters

Optional options: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams

Returns Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraKeyspaceResponse>, CassandraResourcesCreateUpdateCassandraKeyspaceResponse>>

beginCreateUpdateCassandraKeyspaceAndWait

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

createUpdateCassandraKeyspaceParameters: CassandraKeyspaceCreateUpdateParameters

Optional options: CassandraResourcesCreateUpdateCassandraKeyspaceOptionalParams

Returns Promise<CassandraResourcesCreateUpdateCassandraKeyspaceResponse>

beginCreateUpdateCassandraTable

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

tableName: string

createUpdateCassandraTableParameters: CassandraTableCreateUpdateParameters

Optional options: CassandraResourcesCreateUpdateCassandraTableOptionalParams

Returns Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraTableResponse>, CassandraResourcesCreateUpdateCassandraTableResponse>>

beginCreateUpdateCassandraTableAndWait

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

tableName: string

createUpdateCassandraTableParameters: CassandraTableCreateUpdateParameters

Optional options: CassandraResourcesCreateUpdateCassandraTableOptionalParams

Returns Promise<CassandraResourcesCreateUpdateCassandraTableResponse>

beginCreateUpdateCassandraView

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

viewName: string

createUpdateCassandraViewParameters: CassandraViewCreateUpdateParameters

Optional options: CassandraResourcesCreateUpdateCassandraViewOptionalParams

Returns Promise<PollerLike<PollOperationState<CassandraResourcesCreateUpdateCassandraViewResponse>, CassandraResourcesCreateUpdateCassandraViewResponse>>

beginCreateUpdateCassandraViewAndWait

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

viewName: string

createUpdateCassandraViewParameters: CassandraViewCreateUpdateParameters

Optional options: CassandraResourcesCreateUpdateCassandraViewOptionalParams

Returns Promise<CassandraResourcesCreateUpdateCassandraViewResponse>

beginDeleteCassandraKeyspace

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

Optional options: CassandraResourcesDeleteCassandraKeyspaceOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCassandraKeyspaceAndWait

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

Optional options: CassandraResourcesDeleteCassandraKeyspaceOptionalParams

Returns Promise<void>

beginDeleteCassandraTable

Parameters

resourceGroupName: string

accountName: string

keyspaceName: string

tableName: string

Optional options: CassandraResourcesDeleteCassandraTableOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCassandraTableAndWait