az cosmosdb service

Note

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

サービスに対して操作を実行するコマンド。

コマンド

名前	説明	型	状態
az cosmosdb service create	cosmosdb サービス リソースを作成します。	コア	GA
az cosmosdb service create (cosmosdb-preview 拡張機能)	cosmosdb サービス リソースを作成します。	拡張子	プレビュー
az cosmosdb service delete	指定された cosmosdb サービス リソースを削除します。	コア	GA
az cosmosdb service delete (cosmosdb-preview 拡張機能)	指定された cosmosdb サービス リソースを削除します。	拡張子	プレビュー
az cosmosdb service list	アカウントのすべての cosmosdb サービス リソースを一覧表示します。	コア	GA
az cosmosdb service list (cosmosdb-preview 拡張機能)	アカウントのすべての cosmosdb サービス リソースを一覧表示します。	拡張子	プレビュー
az cosmosdb service show	アカウントで cosmosdb サービス リソースを取得します。	コア	GA
az cosmosdb service show (cosmosdb-preview 拡張機能)	アカウントで cosmosdb サービス リソースを取得します。	拡張子	プレビュー
az cosmosdb service update	cosmosdb サービス リソースを更新します。	コア	GA
az cosmosdb service update (cosmosdb-preview 拡張機能)	cosmosdb サービス リソースを更新します。	拡張子	プレビュー

az cosmosdb service create

cosmosdb サービス リソースを作成します。

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

例

cosmosdb サービス リソースを作成します。

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

必須のパラメーター

--account-name -a

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

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

省略可能のパラメーター

--count -c

インスタンス数。

規定値: 1

--gateway-type

専用ゲートウェイの種類。 SqlDedicatedGateway サービスの種類に対してのみ有効です。

指定可能な値: DistributedQuery, IntegratedCache

規定値: IntegratedCache

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--size

インスタンス サイズ。 使用できる値は、Cosmos.D4s、Cosmos.D8s、Cosmos.D16s などです。

規定値: Cosmos.D4s

グローバル パラメーター

--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 service create (cosmosdb-preview 拡張機能)

プレビュー

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

cosmosdb サービス リソースを作成します。

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

例

cosmosdb サービス リソースを作成します。

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

cosmosdb 具体化されたビュー ビルダー サービス リソースを作成します。

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

必須のパラメーター

--account-name -a

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

--kind -k

サービスの種類。

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

省略可能のパラメーター

--count -c

インスタンス数。

規定値: 1

--gateway-type

専用ゲートウェイの種類。 SqlDedicatedGateway サービスの種類に対してのみ有効です。

指定可能な値: DistributedQuery, IntegratedCache

規定値: IntegratedCache

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--size

インスタンス サイズ。 使用できる値は、Cosmos.D4s、Cosmos.D8s、Cosmos.D16s などです。

規定値: Cosmos.D4s

グローバル パラメーター

--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 service delete

指定された cosmosdb サービス リソースを削除します。

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

例

指定された cosmosdb サービス リソースを削除します。

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

必須のパラメーター

--account-name -a

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

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--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 service delete (cosmosdb-preview 拡張機能)

プレビュー

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

指定された cosmosdb サービス リソースを削除します。

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

例

指定された cosmosdb サービス リソースを削除します。

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

cosmosdb 具体化されたビュー ビルダー サービス リソースを削除します。

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

必須のパラメーター

--account-name -a

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

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--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 service list

アカウントのすべての cosmosdb サービス リソースを一覧表示します。

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

例

アカウントのすべての cosmosdb サービス リソースを一覧表示します。

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

必須のパラメーター

--account-name -a

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

--resource-group-name -g

データベース アカウントのリソース グループの名前。

グローバル パラメーター

--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 service list (cosmosdb-preview 拡張機能)

プレビュー

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

アカウントのすべての cosmosdb サービス リソースを一覧表示します。

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

例

アカウントのすべての cosmosdb サービス リソースを一覧表示します。

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

必須のパラメーター

--account-name -a

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

--resource-group-name -g

データベース アカウントのリソース グループの名前。

グローバル パラメーター

--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 service show

アカウントで cosmosdb サービス リソースを取得します。

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

例

アカウントで cosmosdb サービス リソースを取得します。

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

必須のパラメーター

--account-name -a

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

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

グローバル パラメーター

--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 service show (cosmosdb-preview 拡張機能)

プレビュー

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

アカウントで cosmosdb サービス リソースを取得します。

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

例

アカウントで cosmosdb サービス リソースを取得します。

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

必須のパラメーター

--account-name -a

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

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

グローバル パラメーター

--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 service update

cosmosdb サービス リソースを更新します。

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

例

cosmosdb サービス リソースを更新します。

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

必須のパラメーター

--account-name -a

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

--count -c

インスタンス数。

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--size

インスタンス サイズ。 使用できる値は、Cosmos.D4s、Cosmos.D8s、Cosmos.D16s などです。

グローバル パラメーター

--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 service update (cosmosdb-preview 拡張機能)

プレビュー

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

cosmosdb サービス リソースを更新します。

az cosmosdb service update --account-name
                           --count
                           --kind
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

例

cosmosdb サービス リソースを更新します。

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

cosmosdb 具体化されたビュー ビルダー サービス リソースを更新します。

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

必須のパラメーター

--account-name -a

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

--count -c

インスタンス数。

--kind -k

サービスの種類。

--name -n

サービス名:

--resource-group-name -g

データベース アカウントのリソース グループの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--size

インスタンス サイズ。 使用できる値は、Cosmos.D4s、Cosmos.D8s、Cosmos.D16s などです。

グローバル パラメーター

--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 を使います。