你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Get-AzCosmosDBMongoDBCollection

参考

模块:: Az.CosmosDB

获取 CosmosDB MongoDB 集合。

语法

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

Get-AzCosmosDBMongoDBCollection
   [-Name <String>]
   -ParentObject <PSMongoDBDatabaseGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Get-AzCosmosDBMongoDBCollection cmdlet 获取 CosmosDB MongoDB 集合。

示例

示例 1

Get-AzCosmosDBMongoDBCollection -ResourceGroupName rgName -AccountName accountName -DatabaseName dbName -Name collectionName

Name     : collectionName
Id       : /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbDatabases/dbName/collections/collectionName
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource

资源对象包含分析StorageTtl、Id、索引、ShardKey、_etag、_rid、_ts属性。

示例 2

(Get-AzCosmosDBMongoDBCollection -ResourceGroupName rgName -AccountName accountName -DatabaseName dbName -Name collectionName).Resource.ShardKey

Key           Value
----          -----
<ShardKey>    <Value>

此示例获取检索的集合的 ShardKey

参数

-AccountName

Cosmos DB 数据库帐户的名称。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-DatabaseName

数据库名称。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:	IAzureContextContainer
别名:	AzContext, AzureRmContext, AzureCredential
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

集合名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ParentObject

Mongo Database 对象。

类型:	PSMongoDBDatabaseGetResults
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-ResourceGroupName

资源组的名称。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

输入

PSMongoDBDatabaseGetResults

输出

PSMongoDBCollectionGetResults

PSThroughputSettingsGetResults

通过