Edit

Share via

Get-AzCosmosDBMongoDBDatabaseThroughput

  • Reference
Module:
Az.CosmosDB

Gets the CosmosDB throughput properties of MongoDB Database.

Syntax

Get-AzCosmosDBMongoDBDatabaseThroughput
   -ResourceGroupName <String>
   -AccountName <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzCosmosDBMongoDBDatabaseThroughput
   -Name <String>
   -InputObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzCosmosDBMongoDBDatabaseThroughput cmdlet gets the throughput properties of MongoDB Database.

Examples

Example 1

Get-AzCosmosDBMongoDBDatabaseThroughput -ResourceGroupName "rgName" -AccountName "accountName" -Name "databaseName"

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

-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

CosmosDB Account object

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

-Name

Database name.

Type:String
Position:Named
Default value:None
Required:True
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

Inputs

None

Outputs

PSThroughputSettingsGetResults