CassandraResources interface
Interface representing a CassandraResources.
Methods
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CassandraKeyspaceGetResults>, CassandraKeyspaceGetResults>>
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.
The options parameters.
Returns
Promise<CassandraKeyspaceGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CassandraTableGetResults>, CassandraTableGetResults>>
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.
The options parameters.
Returns
Promise<CassandraTableGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CassandraResourcesDeleteCassandraKeyspaceHeaders>, CassandraResourcesDeleteCassandraKeyspaceHeaders>>
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.
The options parameters.
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CassandraResourcesDeleteCassandraTableHeaders>, CassandraResourcesDeleteCassandraTableHeaders>>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<CassandraKeyspaceGetResults>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<CassandraTableGetResults>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
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.
The options parameters.