Partilhar via

az cosmosdb sql container

Note

Este grupo de comandos tem comandos definidos tanto no CLI do Azure como em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerir containers SQL do Azure Cosmos DB.

Comandos

Name Description Tipo Status
az cosmosdb sql container create

Crie um contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container create (cosmosdb-preview extensão)

Crie um contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Extension disponibilidade geral
az cosmosdb sql container delete

Elimine o contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container exists

Verifica se existe um contentor SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container list

Liste os contentores SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container merge

Mescla as partições de um contêiner sql.

 Extension Preview
az cosmosdb sql container redistribute-partition-throughput

Redistribui a taxa de transferência de partição de um contêiner sql.

 Extension Preview
az cosmosdb sql container restore

Restaure um contêiner sql excluído dentro da mesma conta.

 Core disponibilidade geral
az cosmosdb sql container restore (cosmosdb-preview extensão)

Restaure um contêiner sql excluído dentro da mesma conta.

 Extension Preview
az cosmosdb sql container retrieve-partition-throughput

Recupere a taxa de transferência de partição de um contêiner sql.

 Extension Preview
az cosmosdb sql container show

Mostre os detalhes de um contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container throughput

Gerir o throughput do contentor SQL numa conta Azure Cosmos DB.

 Núcleo e Extensão disponibilidade geral
az cosmosdb sql container throughput migrate

Migre a taxa de transferência do contêiner SQL entre o dimensionamento automático e o provisionamento manual.

 Core disponibilidade geral
az cosmosdb sql container throughput migrate (cosmosdb-preview extensão)

Migre a taxa de transferência do contêiner SQL entre o dimensionamento automático e o provisionamento manual.

 Extension disponibilidade geral
az cosmosdb sql container throughput show

Obtenha o throughput do contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container throughput show (cosmosdb-preview extensão)

Obtenha o throughput do contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Extension disponibilidade geral
az cosmosdb sql container throughput update

Atualize a taxa de transferência do contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container throughput update (cosmosdb-preview extensão)

Atualize a taxa de transferência do contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Extension disponibilidade geral
az cosmosdb sql container update

Atualize um contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Core disponibilidade geral
az cosmosdb sql container update (cosmosdb-preview extensão)

Atualize um contentor SQL numa base de dados SQL do Azure Cosmos DB.

 Extension disponibilidade geral

az cosmosdb sql container create

Editar

Crie um contentor SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--analytical-storage-ttl]
                                 [--cep]
                                 [--change-reference]
                                 [--conflict-resolution-policy]
                                 [--full-text-policy]
                                 [--idx]
                                 [--max-throughput]
                                 [--partition-key-version]
                                 [--throughput]
                                 [--ttl]
                                 [--unique-key-policy]
                                 [--vector-embeddings]

Exemplos

Crie um contentor SQL do Azure Cosmos DB.

az cosmosdb sql container create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyContainer --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--partition-key-path -p

Caminho da chave de partição, por exemplo, '/address/zipcode'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--analytical-storage-ttl -t

TTL analítico, quando o armazenamento analítico está ativado.

--cep

Política de criptografia de cliente, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --cep @policy-file.json ou --cep "{"includedPaths": [{"path": "/path1","clientEncryptionKeyId": "key1","encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256","encryptionType": "Deterministic"}],"policyFormatVersion": 2}".

--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--conflict-resolution-policy -c

Política de Resolução de Conflitos, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --conflict-resolution-policy @policy-file.json ou --conflict-resolution-policy "{"mode": "lastWriterWins", "conflictResolutionPath": "/path"}".

--full-text-policy

Política de Texto Completo, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --full-text-policy @policy-file.json ou --full-text-policy "{"fullTextPaths": [{"path": "/ftPath1", "language": "en-US" }]}".

--idx

Política de indexação, você pode inseri-la como uma string ou como um arquivo, por exemplo, --idx @policy-file.json ou --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/\"_etag\"/?"}],"vectorIndexes": [{"path": "/vetor1","type": "flat"}]}".

Propriedade Valor
Default value: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--max-throughput

O recurso de taxa de transferência máxima pode ser dimensionado para (RU/s). Fornecido quando o recurso está habilitado para dimensionamento automático. O valor mínimo pode ser 4000 (RU/s).

--partition-key-version

A versão da chave de partição.

--throughput

A taxa de transferência do contêiner SQL (RU/s). O valor padrão é 400. Omita esse parâmetro se o banco de dados tiver taxa de transferência compartilhada, a menos que o contêiner deva ter taxa de transferência dedicada.

--ttl

TTL padrão. Se o valor estiver ausente ou definido como "-1", os itens não expirarão. Se o valor for definido como "n", os itens expirarão "n" segundos após a hora da última modificação.

--unique-key-policy -u

Política de chave exclusiva, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --unique-key-policy @policy-file.json ou --unique-key-policy "{"uniqueKeys": [{"paths": ["/path/to/key1"]}, {"paths": ["/path/to/key2"]}]}".

--vector-embeddings

Política de incorporação vetorial, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --vector-embeddings @policy-file.json ou --vector-embeddings "{"vectorEmbeddings": [{"path": "/vetor1", "dataType": "float32", "dimensions": 2, "distanceFunction": "dotproduct" }]}".

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container create (cosmosdb-preview extensão)

Crie um contentor SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--analytical-storage-ttl]
                                 [--cep]
                                 [--change-reference]
                                 [--conflict-resolution-policy]
                                 [--idx]
                                 [--materialized-view-definition]
                                 [--max-throughput]
                                 [--partition-key-version]
                                 [--throughput]
                                 [--ttl]
                                 [--unique-key-policy]

Exemplos

Crie um contentor SQL do Azure Cosmos DB.

az cosmosdb sql container create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyContainer --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--partition-key-path -p

Caminho da chave de partição, por exemplo, '/address/zipcode'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--analytical-storage-ttl -t

TTL analítico, quando o armazenamento analítico está ativado.

--cep

Política de criptografia de cliente, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --cep @policy-file.json ou --cep "{ "includedPaths": [{"path": "/path1","clientEncryptionKeyId": "key1","encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256","encryptionType": "Deterministic"}], "policyFormatVersion": 2}".

--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--conflict-resolution-policy -c

Política de Resolução de Conflitos, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --conflict-resolution-policy @policy-file.json ou --conflict-resolution-policy "{ "mode": "lastWriterWins", "conflictResolutionPath": "/path" }".

--idx

Política de indexação, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --idx @policy-file.json ou --idx "{ "indexingMode": "consistente", "automático": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/\"_etag\"/?"}] }".

Propriedade Valor
Default value: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--materialized-view-definition -m

Materialized View Definition, você pode inseri-la como uma string ou como um arquivo, por exemplo, --materialized-view-definition @materializedview-definition-file.json ou --materialized-view-definition -m '{ "sourceCollectionId": "MySourceCollectionName", "definition": "SELECT * FROM root r"}'.

--max-throughput

O recurso de taxa de transferência máxima pode ser dimensionado para (RU/s). Fornecido quando o recurso está habilitado para dimensionamento automático. O valor mínimo pode ser 4000 (RU/s).

--partition-key-version

A versão da chave de partição.

--throughput

A taxa de transferência do contêiner SQL (RU/s). O valor padrão é 400. Omita esse parâmetro se o banco de dados tiver taxa de transferência compartilhada, a menos que o contêiner deva ter taxa de transferência dedicada.

--ttl

TTL padrão. Se o valor estiver ausente ou definido como "-1", os itens não expirarão. Se o valor for definido como "n", os itens expirarão "n" segundos após a hora da última modificação.

--unique-key-policy -u

Política de chave exclusiva, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --unique-key-policy @policy-file.json ou --unique-key-policy "{ "uniqueKeys": [{"paths": ["/path/to/key1"]}, {"paths": ["/path/to/key2"]}] }".

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container delete

Editar

Elimine o contentor SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container delete --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--yes]

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container exists

Editar

Verifica se existe um contentor SQL do Azure Cosmos DB.

az cosmosdb sql container exists --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container list

Editar

Liste os contentores SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container list --account-name
                               --database-name
                               --resource-group

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container merge

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Mescla as partições de um contêiner sql.

az cosmosdb sql container merge --account-name
                                --database-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]

Exemplos

Mesclar partições do contêiner my-container

az cosmosdb sql container merge -g my-resource-group -a my-account -d my-db --name my-container

Parâmetros Obrigatórios

--account-name -a

Nome da conta de banco de dados do CosmosDB.

--database-name -d

Nome do nome do banco de dados do CosmosDB.

--name -n

Nome da coleção CosmosDB.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container redistribute-partition-throughput

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Redistribui a taxa de transferência de partição de um contêiner sql.

az cosmosdb sql container redistribute-partition-throughput --account-name
                                                            --database-name
                                                            --name
                                                            --resource-group
                                                            [--acquire-policy-token]
                                                            [--change-reference]
                                                            [--evenly-distribute {false, true}]
                                                            [--source-partition-info]
                                                            [--target-partition-info]

Exemplos

Distribui uniformemente a taxa de transferência de partição para um contêiner sql entre todas as partições físicas

az cosmosdb sql container redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --evenly-distribute

Redistribui a taxa de transferência de partição para um contêiner sql de partições de origem para partições de destino

az cosmosdb sql container redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --target-partition-info 8=1200 6=1200]' --source-partition-info 9]'

Parâmetros Obrigatórios

--account-name -a

Nome da conta de banco de dados do CosmosDB.

--database-name -d

Nome do nome do banco de dados do CosmosDB.

--name -n

Nome da coleção CosmosDB.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--evenly-distribute

Alterne para distribuir a taxa de transferência igualmente entre todas as partições físicas.

Propriedade Valor
Default value: False
Valores aceites: false, true
--source-partition-info

Ids de partição física de origem separada por espaço, por exemplo: 1 2.

Propriedade Valor
Default value: []
--target-partition-info

Informações sobre a taxa de transferência da partição física de destino desejada, por exemplo: 0=1200 1=1200.

Propriedade Valor
Default value: []
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container restore

Editar

Restaure um contêiner sql excluído dentro da mesma conta.

az cosmosdb sql container restore --account-name
                                  --database-name
                                  --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--disable-ttl]
                                  [--restore-timestamp]

Exemplos

Restaure um contêiner sql excluído dentro da mesma conta.

az cosmosdb sql container restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_container_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--disable-ttl

Sinalizador para restaurar com TTL desativado.

Uso: --disable-ttl True Default: false.

--restore-timestamp -t

O carimbo de data/hora para o qual o contêiner precisa ser restaurado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container restore (cosmosdb-preview extensão)

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Restaure um contêiner sql excluído dentro da mesma conta.

az cosmosdb sql container restore --account-name
                                  --database-name
                                  --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--disable-ttl {false, true}]
                                  [--restore-timestamp]

Exemplos

Restaure um contêiner sql excluído dentro da mesma conta.

az cosmosdb sql container restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_container_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--disable-ttl
Pré-visualizar

Ative ou desative a restauração com ttl desativado.

Propriedade Valor
Valores aceites: false, true
--restore-timestamp -t

O carimbo de data/hora para o qual o contêiner precisa ser restaurado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container retrieve-partition-throughput

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Recupere a taxa de transferência de partição de um contêiner sql.

az cosmosdb sql container retrieve-partition-throughput --account-name
                                                        --database-name
                                                        --name
                                                        --resource-group
                                                        [--acquire-policy-token]
                                                        [--all-partitions {false, true}]
                                                        [--change-reference]
                                                        [--physical-partition-ids]

Exemplos

Recuperar a taxa de transferência do container_name de contêiner para partições físicas específicas

az cosmosdb sql container retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --physical-partition-ids 8 9

Recuperar a taxa de transferência do container_name de contêiner para todas as partições físicas

az cosmosdb sql container retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --all-partitions

Parâmetros Obrigatórios

--account-name -a

Nome da conta de banco de dados do CosmosDB.

--database-name -d

Nome do nome do banco de dados do CosmosDB.

--name -n

Nome do contêiner do CosmosDB.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--all-partitions

Alterne para recuperar a taxa de transferência de todas as partições físicas.

Propriedade Valor
Default value: False
Valores aceites: false, true
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--physical-partition-ids -p

Lista separada por espaço de ids de partição física.

Propriedade Valor
Default value: []
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container show

Editar

Mostre os detalhes de um contentor SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container show --account-name
                               --database-name
                               --name
                               --resource-group

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container update

Editar

Atualize um contentor SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--analytical-storage-ttl]
                                 [--change-reference]
                                 [--full-text-policy]
                                 [--idx]
                                 [--ttl]
                                 [--vector-embeddings]

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--analytical-storage-ttl -t

TTL analítico, quando o armazenamento analítico está ativado.

--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--full-text-policy

Política de Texto Completo, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --full-text-policy @policy-file.json ou --full-text-policy "{"fullTextPaths": [{"path": "/ftPath1", "language": "en-US" }]}".

--idx

Política de indexação, você pode inseri-la como uma string ou como um arquivo, por exemplo, --idx @policy-file.json ou --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/\"_etag\"/?"}],"vectorIndexes": [{"path": "/vetor1","type": "flat"}]}".

--ttl

TTL padrão. Se o valor estiver ausente ou definido como "-1", os itens não expirarão. Se o valor for definido como "n", os itens expirarão "n" segundos após a hora da última modificação.

--vector-embeddings

Política de incorporação vetorial, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --vector-embeddings @policy-file.json ou --vector-embeddings "{"vectorEmbeddings": [{"path": "/vetor1", "dataType": "float32", "dimensions": 2, "distanceFunction": "dotproduct" }]}".

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql container update (cosmosdb-preview extensão)

Atualize um contentor SQL numa base de dados SQL do Azure Cosmos DB.

az cosmosdb sql container update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--analytical-storage-ttl]
                                 [--change-reference]
                                 [--idx]
                                 [--materialized-view-definition]
                                 [--ttl]

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--database-name -d

Nome do banco de dados.

--name -n

Nome do contêiner.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--analytical-storage-ttl -t

TTL analítico, quando o armazenamento analítico está ativado.

--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--idx

Política de indexação, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --idx @policy-file.json ou --idx "{ "indexingMode": "consistente", "automático": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/\"_etag\"/?"}] }".

--materialized-view-definition -m

Materialized View Definition, você pode inseri-la como uma string ou como um arquivo, por exemplo, --materialized-view-definition @materializedview-definition-file.json ou --materialized-view-definition -m '{ "sourceCollectionId": "MySourceCollectionName", "definition": "SELECT * FROM root r"}'.

--ttl

TTL padrão. Se o valor estiver ausente ou definido como "-1", os itens não expirarão. Se o valor for definido como "n", os itens expirarão "n" segundos após a hora da última modificação.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False