Update-AzCosmosDBSqlContainer
Updates the CosmosDB Sql Container. Performs a client side patch operation by reading the existing Container.
Syntax
ByNameParameterSet (Default)
Update-AzCosmosDBSqlContainer
-ResourceGroupName <String>
-AccountName <String>
-DatabaseName <String>
[-Name <String>]
[-IndexingPolicy <PSSqlIndexingPolicy>]
[-PartitionKeyVersion <Int32>]
[-PartitionKeyKind <String>]
[-PartitionKeyPath <String[]>]
[-Throughput <Int32>]
[-AutoscaleMaxThroughput <Int32>]
[-TtlInSeconds <Int32>]
[-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
[-ConflictResolutionPolicyMode <String>]
[-ConflictResolutionPolicyPath <String>]
[-ConflictResolutionPolicyProcedure <String>]
[-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
[-AnalyticalStorageTtl <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-VectorEmbeddingPolicy <PSSqlVectorEmbeddingPolicy>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectParameterSet
Update-AzCosmosDBSqlContainer
-ParentObject <PSSqlDatabaseGetResults>
[-Name <String>]
[-IndexingPolicy <PSSqlIndexingPolicy>]
[-PartitionKeyVersion <Int32>]
[-PartitionKeyKind <String>]
[-PartitionKeyPath <String[]>]
[-Throughput <Int32>]
[-AutoscaleMaxThroughput <Int32>]
[-TtlInSeconds <Int32>]
[-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
[-ConflictResolutionPolicyMode <String>]
[-ConflictResolutionPolicyPath <String>]
[-ConflictResolutionPolicyProcedure <String>]
[-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
[-AnalyticalStorageTtl <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-VectorEmbeddingPolicy <PSSqlVectorEmbeddingPolicy>]
[<CommonParameters>]
ByObjectParameterSet
Update-AzCosmosDBSqlContainer
-InputObject <PSSqlContainerGetResults>
[-Name <String>]
[-IndexingPolicy <PSSqlIndexingPolicy>]
[-PartitionKeyVersion <Int32>]
[-PartitionKeyKind <String>]
[-PartitionKeyPath <String[]>]
[-Throughput <Int32>]
[-AutoscaleMaxThroughput <Int32>]
[-TtlInSeconds <Int32>]
[-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
[-ConflictResolutionPolicyMode <String>]
[-ConflictResolutionPolicyPath <String>]
[-ConflictResolutionPolicyProcedure <String>]
[-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
[-AnalyticalStorageTtl <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-VectorEmbeddingPolicy <PSSqlVectorEmbeddingPolicy>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates the CosmosDB Sql Container. Performs a client side patch operation by reading the existing Container.
Examples
Example 1
Update-AzCosmosDBSqlContainer -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName -Throughput 800
Name : myDatabaseName
Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName
Location :
Tags :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource
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
TTL for Analytical Storage (in Seconds).
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
-ConflictResolutionPolicy
ConflictResolutionPolicy Object of type PSSqlConflictResolutionPolicy, when provided this is set as the ConflictResolutionPolicy of the container.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ConflictResolutionPolicyMode
Can have the values: LastWriterWins, Custom, Manual.
If provided along with ConflictResolutionPolicy parameter, it is ignored.
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
-ConflictResolutionPolicyPath
To be provided when the type is LastWriterWins.
If provided along with ConflictResolutionPolicy parameter, it is ignored.
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
-ConflictResolutionPolicyProcedure
To be provided when the type is custom.
If provided along with ConflictResolutionPolicy parameter, it is ignored.
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
-DatabaseName
Database 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
-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
-IndexingPolicy
Indexing Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlIndexingPolicy.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Sql Container object.
ByObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
Container 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
Sql Database object.
Parameter properties
Parameter sets
ByParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-PartitionKeyKind
The kind of algorithm used for partitioning.
Possible values include: 'Hash', 'Range'
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
-PartitionKeyPath
Partition Key Path, e.g., '/address/zipcode'.
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
-PartitionKeyVersion
The version of the partition key definition
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
-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
-Throughput
The throughput of SQL container (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
-UniqueKeyPolicy
UniqueKeyPolicy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlUniqueKeyPolicy.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-VectorEmbeddingPolicy
VectorEmbedding Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlVectorEmbeddingPolicy.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: True 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 .
Outputs