Edit

Share via

Update-AzCosmosDBCassandraTable

Module:
Az.CosmosDB Module

Updates the CosmosDB Cassandra Table. Performs a client side patch operation by reading the existing Table.

Syntax

ByNameParameterSet (Default) 

Update-AzCosmosDBCassandraTable
    -ResourceGroupName <String>
    -AccountName <String>
    -KeyspaceName <String>
    [-Name <String>]
    [-Throughput <Int32>]
    [-AutoscaleMaxThroughput <Int32>]
    [-TtlInSeconds <Int32>]
    [-AnalyticalStorageTtl <Int32>]
    [-Schema <PSCassandraSchema>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByParentObjectParameterSet 

Update-AzCosmosDBCassandraTable
    -ParentObject <PSCassandraKeyspaceGetResults>
    [-Name <String>]
    [-Throughput <Int32>]
    [-AutoscaleMaxThroughput <Int32>]
    [-TtlInSeconds <Int32>]
    [-AnalyticalStorageTtl <Int32>]
    [-Schema <PSCassandraSchema>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectParameterSet 

Update-AzCosmosDBCassandraTable
    -InputObject <PSCassandraTableGetResults>
    [-Name <String>]
    [-Throughput <Int32>]
    [-AutoscaleMaxThroughput <Int32>]
    [-TtlInSeconds <Int32>]
    [-AnalyticalStorageTtl <Int32>]
    [-Schema <PSCassandraSchema>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Updates the CosmosDB Cassandra Table. Performs a client side patch operation by reading the existing Table.

Examples

Example 1

Update-AzCosmosDBCassandraTable -AccountName myAccountName -ResourceGroupName myRgName -KeyspaceName myKeyspaceName -Name myTableName -Schema updatedSchema

Name     : myTable
Id       : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/cassandraKeyspaces/myKeyspaceName/t
           ables/myTableName
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetPropertiesResource

Parameters

-AccountName

Name of the Cosmos DB database account.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AnalyticalStorageTtl

Analytical Storage TTL.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AutoscaleMaxThroughput

Maximum Throughput value if autoscale is enabled.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Cassandra Table object.

Parameter properties

Type:PSCassandraTableGetResults
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-KeyspaceName

Cassandra Keyspace Name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Cassandra Table Name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentObject

Cassandra Keyspace object.

Parameter properties

Type:PSCassandraKeyspaceGetResults
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByParentObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Name of resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Schema

PSCassandraSchema object. Use New-AzCosmosDBCassandraSchema to create this object.

Parameter properties

Type:PSCassandraSchema
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Throughput

The throughput of Cassandra Keyspace (RU/s). Default value is 400.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TtlInSeconds

Default Ttl in seconds. If the value is missing or set to - 1, items don't expire. If the value is set to n, items will expire n seconds after last modified time.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSCassandraSchema

PSCassandraKeyspaceGetResults

PSCassandraTableGetResults

Outputs

PSCassandraTableGetResults

ResourceNotFoundException