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 コマンドレットは、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

Resource オブジェクトには、AnalyticalStorageTtl、Id、Indexes、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 データベースアカウントの名前。

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

-DatabaseName

データベース名。

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

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

コレクション名。

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

-ParentObject

Mongo Database オブジェクト。

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

-ResourceGroupName

リソースグループの名前。

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

入力

PSMongoDBDatabaseGetResults

出力

PSMongoDBCollectionGetResults

PSThroughputSettingsGetResults