Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzCosmosDBMongoDBCollection
- Module:
- Az.CosmosDB Module
Creates a new CosmosDB MongoDB Collection.
Syntax
ByNameParameterSet (Default)
New-AzCosmosDBMongoDBCollection
-ResourceGroupName <String>
-AccountName <String>
-DatabaseName <String>
-Name <String>
[-Throughput <Int32>]
[-AutoscaleMaxThroughput <Int32>]
[-Shard <String>]
[-AnalyticalStorageTtl <Int32>]
[-Index <PSMongoIndex[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectParameterSet
New-AzCosmosDBMongoDBCollection
-Name <String>
-ParentObject <PSMongoDBDatabaseGetResults>
[-Throughput <Int32>]
[-AutoscaleMaxThroughput <Int32>]
[-Shard <String>]
[-AnalyticalStorageTtl <Int32>]
[-Index <PSMongoIndex[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Creates a new CosmosDB MongoDB Collection.
Examples
Example 1
$ttlInSeconds = 604800
$index1 = New-AzCosmosDBMongoDBIndex -Key @("partitionkey1", "partitionkey2") -Unique 1
$index2 = New-AzCosmosDBMongoDBIndex -Key @("_ts") -TtlInSeconds $ttlInSeconds
New-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -DatabaseName myDatabaseName -Name myCollectionName -Index $index1,$index2 -Shard myShardKey
Name : collection1
Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbDatabases/myDatabaseName/collect
ions/myCollectionName
Location :
Tags :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource
Parameters
-AccountName
Name of the Cosmos DB database account.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AnalyticalStorageTtl
TTL for Analytical Storage.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AutoscaleMaxThroughput
Maximum Throughput value if autoscale is enabled.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DatabaseName
Database name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-Index
Array of PSMongoIndex objects.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Collection name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ParentObject
Mongo Database object.
Parameter properties
| Type: | PSMongoDBDatabaseGetResults |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Name of resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Shard
Sharding key path.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Throughput
The throughput of SQL container (RU/s). Default value is 400.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
PSMongoDBDatabaseGetResults
Outputs
PSMongoDBCollectionGetResults
ConflictingResourceException
Azure PowerShell
Feedback
Was this page helpful?