Get-AzCosmosDBMongoDBCollection
Obtient la collection MongoDB CosmosDB.
Syntaxe
ByNameParameterSet (Par défaut)
Get-AzCosmosDBMongoDBCollection
-ResourceGroupName <String>
-AccountName <String>
-DatabaseName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByParentObjectParameterSet
Get-AzCosmosDBMongoDBCollection
-ParentObject <PSMongoDBDatabaseGetResults>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
L’applet de commande Get-AzCosmosDBMongoDBCollection obtient la collection MongoDB CosmosDB.
Exemples
Exemple 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 Object contient AnalyticalStorageTtl, Id, Index, ShardKey, _etag, _rid, _ts propriétés.
Exemple 2
(Get-AzCosmosDBMongoDBCollection -ResourceGroupName rgName -AccountName accountName -DatabaseName dbName -Name collectionName).Resource.ShardKey
Key Value
---- -----
<ShardKey> <Value>
Cet exemple obtient la clé de partition de la collection récupérée
Paramètres
-AccountName
Nom du compte de base de données Cosmos DB.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-DatabaseName
Nom de la base de données.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Propriétés du paramètre
Type: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Name
Nom de la collection.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ParentObject
Objet Mongo Database.
Propriétés du paramètre
Jeux de paramètres
ByParentObjectParameterSet
Position: Named Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ResourceGroupName
Nom du groupe de ressources.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByNameParameterSet
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters .
Sorties
