Get-AzCosmosDBMongoDBCollection
Obtém a Coleção MongoDB do CosmosDB.
Sintaxe
ByNameParameterSet (Predefinição)
Get-AzCosmosDBMongoDBCollection
-ResourceGroupName <String>
-AccountName <String>
-DatabaseName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByParentObjectParameterSet
Get-AzCosmosDBMongoDBCollection
-ParentObject <PSMongoDBDatabaseGetResults>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Descrição
O cmdlet Get-AzCosmosDBMongoDBCollection obtém a Coleção MongoDB do CosmosDB.
Exemplos
Exemplo 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 contém AnalyticalStorageTtl, Id, Indexes, ShardKey, _etag, _rid _ts propriedades.
Exemplo 2
(Get-AzCosmosDBMongoDBCollection -ResourceGroupName rgName -AccountName accountName -DatabaseName dbName -Name collectionName).Resource.ShardKey
Key Value
---- -----
<ShardKey> <Value>
Este exemplo obtém o ShardKey da coleção recuperada
Parâmetros
-AccountName
Nome da conta de banco de dados do Cosmos DB.
Propriedades dos parâmetros
Tipo: String
Valor predefinido: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
ByNameParameterSet
Posto: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-DatabaseName
Nome do banco de dados.
Propriedades dos parâmetros
Tipo: String
Valor predefinido: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
ByNameParameterSet
Posto: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-DefaultProfile
As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.
Propriedades dos parâmetros
Tipo: IAzureContextContainer
Valor predefinido: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Posto: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Name
Nome da coleção.
Propriedades dos parâmetros
Tipo: String
Valor predefinido: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Posto: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-ParentObject
Objeto Mongo Database.
Propriedades dos parâmetros
Conjuntos de parâmetros
ByParentObjectParameterSet
Posto: Named
Obrigatório: True
Valor do pipeline: True
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-ResourceGroupName
Nome do grupo de recursos.
Propriedades dos parâmetros
Tipo: String
Valor predefinido: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
ByNameParameterSet
Posto: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas