次の方法で共有

az cosmosdb sql database

Note

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

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

コマンド

名前 説明 型 状態
az cosmosdb sql database create

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

 Core GA
az cosmosdb sql database delete

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

 Core GA
az cosmosdb sql database exists

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

 Core GA
az cosmosdb sql database list

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

 Core GA
az cosmosdb sql database merge

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

 Extension Preview
az cosmosdb sql database restore

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

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

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

 Extension Preview
az cosmosdb sql database show

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

 Core GA
az cosmosdb sql database throughput

Azure Cosmos DB アカウントで SQL データベースのスループットを管理します。

 Core GA
az cosmosdb sql database throughput migrate

自動スケーリングと手動プロビジョニングの間で SQL データベースのスループットを移行します。

 Core GA
az cosmosdb sql database throughput show

Azure Cosmos DB アカウントで SQL データベースのスループットを取得します。

 Core GA
az cosmosdb sql database throughput update

Azure Cosmos DB アカウントで SQL データベースのスループットを更新します。

 Core 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>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-throughput

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

--throughput

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb sql database restore

編集

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

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--disable-ttl]
                                 [--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>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl

TTL を無効にして復元するフラグ。

使用法: --disable-ttl True 既定値: false。

--restore-timestamp -t

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl
プレビュー

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

プロパティ 値
指定可能な値: false, true
--restore-timestamp -t

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False