az cosmosdb service

Note

Tato skupina příkazů obsahuje příkazy definované v Azure CLI i alespoň jednom rozšíření. Nainstalujte každé rozšíření, abyste mohli využívat své rozšířené funkce. Přečtěte si další informace o rozšířeních.

Příkazy pro provádění operací ve službě

Příkazy

Name Description Typ Stav
az cosmosdb service create

Vytvořte prostředek služby CosmosDB.

Core GA
az cosmosdb service create (cosmosdb-preview přípona)

Vytvořte prostředek služby CosmosDB.

Extension Preview
az cosmosdb service delete

Odstraňte daný prostředek služby CosmosDB.

Core GA
az cosmosdb service delete (cosmosdb-preview přípona)

Odstraňte daný prostředek služby CosmosDB.

Extension Preview
az cosmosdb service list

Vypíše všechny prostředky služby CosmosDB v rámci účtu.

Core GA
az cosmosdb service list (cosmosdb-preview přípona)

Vypíše všechny prostředky služby CosmosDB v rámci účtu.

Extension Preview
az cosmosdb service show

Získejte prostředek služby CosmosDB pod účtem.

Core GA
az cosmosdb service show (cosmosdb-preview přípona)

Získejte prostředek služby CosmosDB pod účtem.

Extension Preview
az cosmosdb service update

Aktualizujte prostředek služby CosmosDB.

Core GA
az cosmosdb service update (cosmosdb-preview přípona)

Aktualizujte prostředek služby CosmosDB.

Extension Preview

az cosmosdb service create

Vytvořte prostředek služby CosmosDB.

az cosmosdb service create --account-name
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Příklady

Vytvořte prostředek služby CosmosDB.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--count -c

Počet instancí.

Vlastnost Hodnota
Default value: 1
--gateway-type

Typ vyhrazené brány. Platné pouze pro typ služby SqlDedicatedGateway.

Vlastnost Hodnota
Default value: IntegratedCache
Přípustné hodnoty: DistributedQuery, IntegratedCache
--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost Hodnota
Default value: False
--size

Velikost instance. Možné hodnoty jsou: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s atd.

Vlastnost Hodnota
Default value: Cosmos.D4s
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service create (cosmosdb-preview přípona)

Preview

Skupina příkazů CosmosDB je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Vytvořte prostředek služby CosmosDB.

az cosmosdb service create --account-name
                           --kind
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Příklady

Vytvořte prostředek služby CosmosDB.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Vytvořte prostředek služby tvůrce materializovaných zobrazení cosmosDB.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3 --size "Cosmos.D4s"

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--kind -k

Druh služby.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--count -c

Počet instancí.

Vlastnost Hodnota
Default value: 1
--gateway-type

Typ vyhrazené brány. Platné pouze pro typ služby SqlDedicatedGateway.

Vlastnost Hodnota
Default value: IntegratedCache
Přípustné hodnoty: DistributedQuery, IntegratedCache
--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost Hodnota
Default value: False
--size

Velikost instance. Možné hodnoty jsou: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s atd.

Vlastnost Hodnota
Default value: Cosmos.D4s
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service delete

Odstraňte daný prostředek služby CosmosDB.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--yes]

Příklady

Odstraňte daný prostředek služby CosmosDB.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost Hodnota
Default value: False
--yes -y

Nevyzývejte k potvrzení.

Vlastnost Hodnota
Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service delete (cosmosdb-preview přípona)

Preview

Skupina příkazů CosmosDB je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Odstraňte daný prostředek služby CosmosDB.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--yes]

Příklady

Odstraňte daný prostředek služby CosmosDB.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Odstraňte prostředek služby tvůrce materializovaných zobrazení cosmosDB.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder"

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost Hodnota
Default value: False
--yes -y

Nevyzývejte k potvrzení.

Vlastnost Hodnota
Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service list

Vypíše všechny prostředky služby CosmosDB v rámci účtu.

az cosmosdb service list --account-name
                         --resource-group-name

Příklady

Vypíše všechny prostředky služby CosmosDB v rámci účtu.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service list (cosmosdb-preview přípona)

Preview

Skupina příkazů CosmosDB je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Vypíše všechny prostředky služby CosmosDB v rámci účtu.

az cosmosdb service list --account-name
                         --resource-group-name

Příklady

Vypíše všechny prostředky služby CosmosDB v rámci účtu.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service show

Získejte prostředek služby CosmosDB pod účtem.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Příklady

Získejte prostředek služby CosmosDB pod účtem.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service show (cosmosdb-preview přípona)

Preview

Skupina příkazů CosmosDB je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Získejte prostředek služby CosmosDB pod účtem.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Příklady

Získejte prostředek služby CosmosDB pod účtem.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service update

Aktualizujte prostředek služby CosmosDB.

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--size]

Příklady

Aktualizujte prostředek služby CosmosDB.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--count -c

Počet instancí.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost Hodnota
Default value: False
--size

Velikost instance. Možné hodnoty jsou: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s atd.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az cosmosdb service update (cosmosdb-preview přípona)

Preview

Skupina příkazů CosmosDB je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Aktualizujte prostředek služby CosmosDB.

az cosmosdb service update --account-name
                           --count
                           --kind
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--size]

Příklady

Aktualizujte prostředek služby CosmosDB.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3

Aktualizujte prostředek služby tvůrce materializovaných zobrazení cosmosDB.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3

Povinné parametry

--account-name -a

Název účtu databáze Cosmos DB.

--count -c

Počet instancí.

--kind -k

Druh služby.

--name -n

Název služby.

--resource-group-name -g

Název skupiny prostředků databázového účtu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost Hodnota
Default value: False
--size

Velikost instance. Možné hodnoty jsou: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s atd.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False