Update-AzCosmosDBMongoDBCollection

Módulo:
Az.CosmosDB Module

Atualiza a Coleção MongoDB do CosmosDB. Executa uma operação de patch do lado do cliente lendo a Coleção existente.

Sintaxe

ByNameParameterSet (Predefinição) 

Update-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 

Update-AzCosmosDBMongoDBCollection
    -ParentObject <PSMongoDBDatabaseGetResults>
    [-Name <String>]
    [-Throughput <Int32>]
    [-AutoscaleMaxThroughput <Int32>]
    [-Shard <String>]
    [-AnalyticalStorageTtl <Int32>]
    [-Index <PSMongoIndex[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectParameterSet 

Update-AzCosmosDBMongoDBCollection
    -InputObject <PSMongoDBCollectionGetResults>
    [-Name <String>]
    [-Throughput <Int32>]
    [-AutoscaleMaxThroughput <Int32>]
    [-Shard <String>]
    [-AnalyticalStorageTtl <Int32>]
    [-Index <PSMongoIndex[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

Atualiza a Coleção MongoDB do CosmosDB. Executa uma operação de patch do lado do cliente lendo a Coleção existente.

Exemplos

Exemplo 1

Update-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -DatabaseName myDatabaseName -Name myCollectionName -Index $index1,$index2

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

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

-AnalyticalStorageTtl

TTL para armazenamento analítico.

Propriedades dos parâmetros

Tipo:

Nullable<T>[Int32]

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

-AutoscaleMaxThroughput

Valor de Taxa de Transferência Máxima se o dimensionamento automático estiver habilitado.

Propriedades dos parâmetros

Tipo:

Nullable<T>[Int32]

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

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

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

-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

-Index

Matriz de objetos PSMongoIndex.

Propriedades dos parâmetros

Tipo:

PSMongoIndex[]

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

-InputObject

Objeto Sql Container.

Propriedades dos parâmetros

Tipo:PSMongoDBCollectionGetResults
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByObjectParameterSet
Posto:Named
Obrigatório:True
Valor do pipeline:True
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

Tipo:PSMongoDBDatabaseGetResults
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

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

-Shard

Caminho chave de compartilhamento.

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

-Throughput

A taxa de transferência do contêiner SQL (RU/s). O valor padrão é 400.

Propriedades dos parâmetros

Tipo:

Nullable<T>[Int32]

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

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

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.

Entradas

PSMongoDBDatabaseGetResults

PSMongoDBCollectionGetResults

Saídas

PSMongoDBCollectionGetResults

ResourceNotFoundException