Get-AzCosmosDBMongoDBCollectionThroughput
Gets the CosmosDB throughput properties of MongoDB Collection.
Syntax
Get-AzCosmosDBMongoDBCollectionThroughput
-ResourceGroupName <String>
-AccountName <String>
-DatabaseName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Get-AzCosmosDBMongoDBCollectionThroughput
[-Name <String>]
-InputObject <PSMongoDBCollectionGetResults>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Get-AzCosmosDBMongoDBCollectionThroughput cmdlet gets the throughput properties of MongoDB Collection.
Examples
Example 1
Get-AzCosmosDBMongoDBCollectionThroughput -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "databaseName" -Name "collectionName"
Name: {throughputName}
Id: {Id}
Throughput: {value}
MinimumThroughput: {value}
OfferReplacePending: {value}
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 |
-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
If provided then, the cmdlet returns the collection with the corresponding throughput value.
Type: | PSMongoDBCollectionGetResults |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Collection name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-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
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell