az cosmosdb sql database

リファレンス

Note

このコマンドグループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。各拡張機能をインストールして、拡張機能を活用します。拡張機能の詳細をご覧ください。

Azure Cosmos DB の SQL データベースを管理します。

コマンド

名前	説明	型	状態
az cosmosdb sql database create	Azure Cosmos DB アカウントで SQL データベースを作成します。	コア	GA
az cosmosdb sql database delete	Azure Cosmos DB アカウントの SQL データベースを削除します。	コア	GA
az cosmosdb sql database exists	Azure Cosmos DB SQL データベースが存在するかどうかを確認します。	コア	GA
az cosmosdb sql database list	Azure Cosmos DB アカウントの SQL データベースを一覧表示します。	コア	GA
az cosmosdb sql database merge	SQL データベースのパーティションをマージします。	拡張機能	プレビュー
az cosmosdb sql database restore	削除された SQL データベースを同じアカウント内に復元します。	コア	GA
az cosmosdb sql database restore (cosmosdb-preview 拡張機能)	削除された SQL データベースを同じアカウント内に復元します。	拡張機能	プレビュー
az cosmosdb sql database show	Azure Cosmos DB アカウントの下に SQL データベースの詳細を表示します。	コア	GA
az cosmosdb sql database throughput	Azure Cosmos DB アカウントで SQL データベースのスループットを管理します。	コア	GA
az cosmosdb sql database throughput migrate	自動スケーリングと手動プロビジョニングの間で SQL データベースのスループットを移行します。	コア	GA
az cosmosdb sql database throughput show	Azure Cosmos DB アカウントで SQL データベースのスループットを取得します。	コア	GA
az cosmosdb sql database throughput update	Azure Cosmos DB アカウントで SQL データベースのスループットを更新します。	コア	GA

az cosmosdb sql database create

編集

Azure Cosmos DB アカウントで SQL データベースを作成します。

az cosmosdb sql database create --account-name
                                --name
                                --resource-group
                                [--max-throughput]
                                [--throughput]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--name -n

データベース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--max-throughput

最大スループットリソースは、(RU/秒) にスケーリングできます。リソースが自動スケーリングが有効な場合に提供されます。最小値は 4000 (RU/秒) にすることができます。

--throughput

SQL データベースのスループット (RU/秒)。既定値は 400 です。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database delete

編集

Azure Cosmos DB アカウントの SQL データベースを削除します。

az cosmosdb sql database delete --account-name
                                --name
                                --resource-group
                                [--yes]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--name -n

データベース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database exists

編集

Azure Cosmos DB SQL データベースが存在するかどうかを確認します。

az cosmosdb sql database exists --account-name
                                --name
                                --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--name -n

データベース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database list

編集

Azure Cosmos DB アカウントの SQL データベースを一覧表示します。

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

例

Azure Cosmos DB アカウントの SQL データベースを一覧表示する (自動生成)

az cosmosdb sql database list --account-name MyAccount --resource-group MyResourceGroup

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database merge

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

SQL データベースのパーティションをマージします。

az cosmosdb sql database merge --account-name
                               --name
                               --resource-group

例

データベース my-database のパーティションをマージする

az cosmosdb sql database merge -g my-resource-group -a my-account --name my-database

必須のパラメーター

--account-name -a

CosmosDB データベースアカウントの名前。

--name -n

CosmosDB データベース名の名前。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database restore

編集

削除された SQL データベースを同じアカウント内に復元します。

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--restore-timestamp]

例

削除された SQL データベースを同じアカウント内に復元します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--name -n

データベース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--restore-timestamp -t

データベースを復元する必要があるタイムスタンプ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database restore (cosmosdb-preview 拡張機能)

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

削除された SQL データベースを同じアカウント内に復元します。

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--disable-ttl {false, true}]
                                 [--restore-timestamp]

例

削除された SQL データベースを同じアカウント内に復元します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--name -n

データベース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--disable-ttl

プレビュー

ttl を無効にして復元を有効または無効にします。

指定可能な値: false, true

--restore-timestamp -t

データベースを復元する必要があるタイムスタンプ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az cosmosdb sql database show

編集

Azure Cosmos DB アカウントの下に SQL データベースの詳細を表示します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--name -n

データベース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az cosmosdb sql database

コマンド

az cosmosdb sql database create

必須のパラメーター

省略可能のパラメーター

az cosmosdb sql database delete

必須のパラメーター

省略可能のパラメーター

az cosmosdb sql database exists

必須のパラメーター

az cosmosdb sql database list

例

必須のパラメーター

az cosmosdb sql database merge

例

必須のパラメーター

az cosmosdb sql database restore

例

必須のパラメーター

省略可能のパラメーター

az cosmosdb sql database restore (cosmosdb-preview 拡張機能)

例

必須のパラメーター

省略可能のパラメーター

az cosmosdb sql database show

必須のパラメーター

その他のリソース