az horizondb

Note

このリファレンスは、Azure CLI (バージョン 2.17.1 以降) の horizondb 拡張機能の一部です。 拡張機能は、 az horizondb コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

HorizonDB Azure管理します。

コマンド

名前 説明 状態
az horizondb create

HorizonDB クラスター Azure新しいクラスターを作成します。

Extension GA
az horizondb delete

Azure HorizonDB クラスターを削除します。

Extension GA
az horizondb firewall-rule

Azure HorizonDB クラスターのファイアウォール規則を管理します。

Extension GA
az horizondb firewall-rule create

Azure HorizonDB クラスターのファイアウォール規則を作成します。

Extension GA
az horizondb firewall-rule delete

Azure HorizonDB クラスターのファイアウォール規則を削除します。

Extension GA
az horizondb firewall-rule list

Azure HorizonDB クラスターのファイアウォール規則を一覧表示します。

Extension GA
az horizondb firewall-rule show

Azure HorizonDB クラスターのファイアウォール規則の詳細を表示します。

Extension GA
az horizondb firewall-rule update

Azure HorizonDB クラスターのファイアウォール規則を更新します。

Extension GA
az horizondb list

HorizonDB クラスター Azure一覧表示します。

Extension GA
az horizondb parameter-group

HorizonDB パラメーター グループAzure管理します。

Extension GA
az horizondb parameter-group create

HorizonDB パラメーター グループAzure新しく作成します。

Extension GA
az horizondb parameter-group delete

Azure HorizonDB パラメーター グループを削除します。

Extension GA
az horizondb parameter-group list

HorizonDB パラメーター グループAzure一覧表示します。

Extension GA
az horizondb parameter-group list-connections

パラメーター グループAzure接続されている HorizonDB クラスターを一覧表示します。

Extension GA
az horizondb parameter-group show

Azure HorizonDB パラメーター グループの詳細を表示します。

Extension GA
az horizondb private-endpoint-connection

HorizonDB プライベート エンドポイント接続を管理します。

Extension GA
az horizondb private-endpoint-connection approve

HorizonDB プライベート エンドポイント接続を承認します。

Extension GA
az horizondb private-endpoint-connection delete

HorizonDB プライベート エンドポイント接続を削除します。

Extension GA
az horizondb private-endpoint-connection list

HorizonDB クラスターのプライベート エンドポイント接続を一覧表示します。

Extension GA
az horizondb private-endpoint-connection reject

HorizonDB プライベート エンドポイント接続を拒否します。

Extension GA
az horizondb private-endpoint-connection show

HorizonDB プライベート エンドポイント接続の詳細を表示します。

Extension GA
az horizondb private-link-resource

HorizonDB プライベート リンク リソースを管理します。

Extension GA
az horizondb private-link-resource list

HorizonDB クラスターのプライベート リンク リソースを一覧表示します。

Extension GA
az horizondb private-link-resource show

HorizonDB プライベート リンク リソースの詳細を表示します。

Extension GA
az horizondb show

Azure HorizonDB クラスターの詳細を表示します。

Extension GA
az horizondb update

既存のAzure HorizonDB クラスターを更新します。

Extension GA

az horizondb create

HorizonDB クラスター Azure新しいクラスターを作成します。

az horizondb create --administrator-login
                    --administrator-login-password
                    [--acquire-policy-token]
                    [--change-reference]
                    [--location]
                    [--name]
                    [--public-access]
                    [--replica-count]
                    [--resource-group]
                    [--tags]
                    [--v-cores]
                    [--version]
                    [--yes]
                    [--zone-placement-policy {BestEffort, Strict}]

新しい HorizonDB クラスターを作成します。

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --replica-count 3

ゾーン配置ポリシーを使用して HorizonDB クラスターを作成します。

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --replica-count 3 --zone-placement-policy Strict

HorizonDB クラスターを作成し、1 つの IP アドレスからのパブリック アクセスを許可します (ファイアウォール規則を作成します)。

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --public-access 12.12.12.12

HorizonDB クラスターを作成し、さまざまな IP アドレスからのパブリック アクセスを許可します。

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --public-access 12.12.12.0-12.12.12.255

HorizonDB クラスターを作成し、すべての IP アドレスからのパブリック アクセスを許可します。

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --public-access All

必須のパラメーター

--administrator-login -u

クラスターの管理者ログイン名。

--administrator-login-password -p

管理者ログイン パスワード。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--name -n

クラスターの名前。 名前に含めることができるのは、英小文字、数字、ハイフン (-) のみです。 3 文字以上、最大 63 文字。

--public-access

既定のプールにファイアウォール規則を作成して、クラスターのパブリック アクセスを決定します。 IP の許可リストに含める 1 つの IP アドレスまたは IP アドレスの範囲 (ダッシュ区切り、スペースなし) を入力します。 'All' を指定すると、任意の IP (0.0.0.0-255.255.255.255) からのパブリック アクセスが許可されます。 'Enabled' は、現在のクライアント IP を検出し、それを許可するように求めます。 'None' と 'Disabled' はファイアウォール規則を作成しません。 使用可能な値: 'Enabled'、'Disabled'、'All'、'None'、'{startIP}' および '{startIP}-{endIP}' です。各 IP の範囲は 0.0.0.0 から 255.255.255.255 です。

--replica-count -r

レプリカの数。 1 ~ 16 の範囲で指定する必要があります。

--resource-group -g

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--v-cores

vCoreの数。

--version -v

PostgreSQL メジャー バージョンを指定します。

--yes -y

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

プロパティ
規定値: False
--zone-placement-policy -z

レプリカが可用性ゾーンにまたがって配置する方法を定義します。

プロパティ
指定可能な値: BestEffort, Strict
グローバル パラメーター
--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 horizondb delete

Azure HorizonDB クラスターを削除します。

az horizondb delete [--acquire-policy-token]
                    [--change-reference]
                    [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--yes]

Azure HorizonDB クラスターを削除します。

az horizondb delete --name examplecluster --resource-group exampleresourcegroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ
パラメーター グループ: Resource Id Arguments
--name -n

クラスターの名前。 名前に含めることができるのは、英小文字、数字、ハイフン (-) のみです。 3 文字以上、最大 63 文字。

プロパティ
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ
パラメーター グループ: Resource Id Arguments
--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/ を参照してください。

--verbose

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

プロパティ
規定値: False

az horizondb list

HorizonDB クラスター Azure一覧表示します。

az horizondb list [--resource-group]

現在のサブスクリプションのすべてのAzure HorizonDB クラスターを一覧表示します。

az horizondb list

リソース グループAzure HorizonDB クラスターを一覧表示します。

az horizondb list --resource-group exampleresourcegroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

Azure HorizonDB クラスターの詳細を表示します。

az horizondb show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Azure HorizonDB クラスターの詳細を表示します。

az horizondb show --name examplecluster --resource-group exampleresourcegroup

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ
パラメーター グループ: Resource Id Arguments
--name -n

クラスターの名前。 名前に含めることができるのは、英小文字、数字、ハイフン (-) のみです。 3 文字以上、最大 63 文字。

プロパティ
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

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

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

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

--only-show-errors

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

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

出力フォーマット。

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

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

--verbose

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

プロパティ
規定値: False

az horizondb update

既存のAzure HorizonDB クラスターを更新します。

az horizondb update [--acquire-policy-token]
                    [--administrator-login-password]
                    [--change-reference]
                    [--ids]
                    [--name]
                    [--no-wait]
                    [--parameter-group]
                    [--public-access {Disabled, Enabled}]
                    [--resource-group]
                    [--subscription]
                    [--tags]
                    [--v-cores]
                    [--yes]

既存の HorizonDB クラスターを 6 個の仮想コアに更新します。

az horizondb update --name examplecluster --resource-group exampleresourcegroup --v-cores 6

既存の HorizonDB クラスターにパラメーター グループを割り当てます。

az horizondb update --name examplecluster --resource-group exampleresourcegroup --parameter-group /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/parameterGroups/{parameterGroup}

既存の HorizonDB クラスターでパブリック アクセスを有効にします (クライアント IP を検出し、ファイアウォール規則を作成するように求められます)。

az horizondb update --name examplecluster --resource-group exampleresourcegroup --public-access Enabled

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--administrator-login-password -p

管理者ログイン パスワード。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ
パラメーター グループ: Resource Id Arguments
--name -n

クラスターの名前。 名前に含めることができるのは、英小文字、数字、ハイフン (-) のみです。 3 文字以上、最大 63 文字。

プロパティ
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--parameter-group

パラメーター グループのリソース識別子。

--public-access

クラスターのパブリック アクセスを有効または無効にします。 'Enabled' は、現在のクライアント IP を検出し、既定のプールにファイアウォール規則を作成するように求めます。 'Disabled' は、パブリック アクセスを削除する 'az horizondb firewall-rule' コマンドを指します。

プロパティ
指定可能な値: Disabled, Enabled
--resource-group -g

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

プロパティ
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ
パラメーター グループ: Resource Id Arguments
--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--v-cores

vCoreの数。

--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/ を参照してください。

--verbose

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

プロパティ
規定値: False