Update-AzCosmosDBSqlContainerThroughput

Reference

Module:: Az.CosmosDB

Updates the throughput value of a CosmosDB Sql Container.

Syntax

Update-AzCosmosDBSqlContainerThroughput
      -DatabaseName <String>
      [-Name <String>]
      -ResourceGroupName <String>
      -AccountName <String>
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCosmosDBSqlContainerThroughput
      [-Name <String>]
      -ParentObject <PSSqlDatabaseGetResults>
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCosmosDBSqlContainerThroughput
      [-Name <String>]
      -InputObject <PSSqlContainerGetResults>
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates the throughput value of a CosmosDB Sql Container.

Examples

Example 1

Update-AzCosmosDBSqlContainerThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -DatabaseName "myDatabaseName" -Name "myContainerName" -Throughput $updatedThroughputValue

Name                : mxGp
Id                  : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/sqlDatabases/{myDatabaseName}/conatiners/{myContainerName}/throughputSettings/default
Throughput          : {updatedThroughputValue}
MinimumThroughput   : 400
OfferReplacePending :

Example 2

Updates the throughput value of a CosmosDB Sql Container. (autogenerated)

Update-AzCosmosDBSqlContainerThroughput -AccountName myAccountName -AutoscaleMaxThroughput <Int32> -DatabaseName myDatabaseName -Name dbname -ResourceGroupName rg1

Parameters

-AccountName

Name of the Cosmos DB database account.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoscaleMaxThroughput

Maximum Throughput value if autoscale is enabled.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

Database name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Sql Database object.

Type:	PSSqlContainerGetResults
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Container name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ParentObject

Sql Database object.

Type:	PSSqlDatabaseGetResults
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Name of resource group.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Throughput

The throughput of SQL container (RU/s). Default value is 400.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSSqlDatabaseGetResults

Outputs

PSThroughputSettingsGetResults

Freigeben über