Set CosmosDbOffer - PlagueHO/CosmosDB GitHub Wiki
Update an existing offer in a Cosmos DB database.
Set-CosmosDbOffer -Context <Context> [-Key <SecureString>] -InputObject <Object[]> [-OfferVersion <String>]
[-OfferType <String>] [-OfferThroughput <Int32>] [-OfferIsRUPerMinuteThroughputEnabled <Boolean>]
[<CommonParameters>]Set-CosmosDbOffer -Account <String> [-Key <SecureString>] [-KeyType <String>] -InputObject <Object[]>
[-OfferVersion <String>] [-OfferType <String>] [-OfferThroughput <Int32>]
[-OfferIsRUPerMinuteThroughputEnabled <Boolean>] [<CommonParameters>]This cmdlet will update an offer resource in Cosmos DB.
Get-CosmosDbOffer -Context $cosmosDbContext -Id 'lyiu' | Set-CosmosDbOffer -Context $cosmosDbContext -OfferThroughput 1000 -OfferIsRUPerMinuteThroughputEnabled $trueUpdate an existing V2 offer with the Id 'lyiu' to set a different throughput.
The account name of the Cosmos DB to access.
Type: String
Parameter Sets: Account
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by `New-CosmosDbContext`.
Type: Context
Parameter Sets: Context
Aliases: Connection
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis must contain one oo more offer records to update.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThe key to be used to access this Cosmos DB.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe type of key that will be used to access ths Cosmos DB.
Type: String
Parameter Sets: Account
Aliases:
Accepted values: master, resource
Required: False
Position: Named
Default value: Master
Accept pipeline input: False
Accept wildcard characters: FalseThe offer is RU per minute throughput enabled. Applicable for V2 offers only.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis contains the throughput of the collection. Applicable for V2 offers only.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseThis is a user settable property, which must be set to S1, S2, or S3 for pre-defined performance levels, and Invalid for user-defined performance levels.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: S1, S2, S3, Invalid
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis can be V1 for pre-defined throughput levels and V2 for user-defined throughput levels.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: V1, V2
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).