Get-AzCosmosDBSqlDatabaseThroughput

Reference

Module:: Az.CosmosDB

Gets the throughput settings corresponding to a CosmosDB Sql Database.

Syntax

Get-AzCosmosDBSqlDatabaseThroughput
   -ResourceGroupName <String>
   -AccountName <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzCosmosDBSqlDatabaseThroughput
   -Name <String>
   -InputObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzCosmosDBSqlDatabaseThroughput cmdlet gets the throughput settings corresponding to a CosmosDB Sql Database.

Examples

Example 1

Get-AzCosmosDBSqlDatabaseThroughput -AccountName "accountName" -ResourceGroupName "resourceGroupName" -Name "databaseName"

Name                : {throughputResourceName}
Id                  : {throughputId}
Throughput          : 0
MinimumThroughput   :
OfferReplacePending :

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:	True
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

Share via