次の方法で共有

az vm host

  • リファレンス

仮想マシンの専用ホストを管理します。

コマンド

名前 説明 型 状態
az vm host create

専用ホストを作成します。

 コア GA
az vm host delete

専用ホストを削除します。

 コア GA
az vm host get-instance-view

専用ホストに関するインスタンス情報を取得します。

 コア GA
az vm host group

専用ホスト グループを管理します。

 コア GA
az vm host group create

専用ホスト グループを作成します。

 コア GA
az vm host group delete

専用ホスト グループを削除します。

 コア GA
az vm host group get-instance-view

専用ホスト グループのインスタンス ビューを取得します。

 コア GA
az vm host group list

専用ホスト グループを一覧表示します。

 コア GA
az vm host group show

専用ホスト グループの詳細を取得します。

 コア GA
az vm host group update

専用ホスト グループを更新します。

 コア GA
az vm host list

専用ホストを一覧表示します。

 コア GA
az vm host list-resize-options

指定した専用ホストのサイズを変更できる使用可能なすべての専用ホスト サイズを一覧表示します。 注: 提供される専用ホスト サイズは、既存の専用ホストのみをスケールアップするために使用できます。

 コア GA
az vm host redeploy

専用ホストを再デプロイします。

 コア GA
az vm host resize

専用ホストのサイズを変更します。

 コア GA
az vm host restart

専用ホストを再起動します。

 コア GA
az vm host show

専用ホストの詳細を取得します。

 コア GA
az vm host update

専用ホストを更新します。

 コア GA
az vm host wait

条件が満たされるまで CLI を待機状態にします。

 コア GA

az vm host create

編集

専用ホストを作成します。

az vm host create --host-group
                  --name
                  --resource-group
                  --sku
                  [--auto-replace {false, true}]
                  [--license-type {None, Windows_Server_Hybrid, Windows_Server_Perpetual}]
                  [--location]
                  [--platform-fault-domain]
                  [--tags]

例

専用ホストを作成します。 障害発生時に自動置換されることを確認する

az vm host create --host-group my-host-group --name my-host --platform-fault-domain 2 \
    --auto-replace --resource-group my-resource-group --sku DSv3-Type1

"東アジア" リージョンに専用ホストを作成します。 障害発生時に自動置換を行わない。

az vm host create --host-group my-host-group --name my-host --platform-fault-domain 0 \
    --auto-replace false --resource-group my-resource-group --sku ESv3-Type1 --location eastasia

専用ホストを作成する (自動生成)

az vm host create --auto-replace true --host-group my-host-group --license-type None --location eastasia --name my-host --resource-group my-resource-group --sku DSv3-Type1

必須のパラメーター

--host-group

専用ホスト グループの名前。

--name -n

専用ホストの名前。

--resource-group -g

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

--sku

専用ホストの SKU。 使用可能な SKU: https://azure.microsoft.com/pricing/details/virtual-machines/dedicated-host/.

省略可能のパラメーター

--auto-replace

障害が発生した場合は、ホストを自動的に置き換えます。

指定可能な値: false, true
--license-type

専用ホストにデプロイされた VM に適用されるソフトウェア ライセンスの種類。

指定可能な値: None, Windows_Server_Hybrid, Windows_Server_Perpetual
--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。 それ以外の場合、場所は既定でリソース グループの場所になります。

--platform-fault-domain -d

グループ内のホストの障害の実行メイン。 使用できる値: 0、1、2。

--tags

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

グローバル パラメーター
--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 vm host delete

編集

専用ホストを削除します。

az vm host delete [--host-group]
                  [--host-name]
                  [--ids]
                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                  [--resource-group]
                  [--subscription]
                  [--yes]

省略可能のパラメーター

--host-group --host-group-name

専用ホスト グループの名前。

--host-name --name -n

専用ホストの名前。

--ids

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--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 vm host get-instance-view

編集

専用ホストに関するインスタンス情報を取得します。

az vm host get-instance-view [--host-group]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

例

専用ホストのインスタンス ビュー情報を取得します。

az vm host get-instance-view --host-group my-host-group --name my-host -g my-rg

ホスト グループ内のすべての専用ホストのインスタンス ビューを取得します。

az vm host get-instance-view --ids $(az vm host list -g my-rg --host-group my-host-group --query "[].id" -o tsv)

省略可能のパラメーター

--host-group

専用ホスト グループの名前。

--ids

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

--name -n

専用ホストの名前。

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 vm host list

編集

専用ホストを一覧表示します。

az vm host list --host-group
                --resource-group
                [--max-items]
                [--next-token]

例

専用ホストを一覧表示します。

az vm host list --host-group MyHostGroup --resource-group MyResourceGroup

必須のパラメーター

--host-group --host-group-name

専用ホスト グループの名前。

--resource-group -g

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

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター
--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 vm host list-resize-options

編集

指定した専用ホストのサイズを変更できる使用可能なすべての専用ホスト サイズを一覧表示します。 注: 提供される専用ホスト サイズは、既存の専用ホストのみをスケールアップするために使用できます。

az vm host list-resize-options [--host-group]
                               [--host-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

例

指定した専用ホストのサイズを変更できる使用可能なすべての専用ホスト サイズを一覧表示します。

az vm host list-resize-options --host-group MyHostGroup --name MyHost --resource-group MyResourceGroup

省略可能のパラメーター

--host-group --host-group-name

専用ホスト グループの名前。

--host-name --name -n

専用ホストの名前。

--ids

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

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 vm host redeploy

編集

専用ホストを再デプロイします。

専用ホストが新しいノードに移行され、実行されると、操作は正常に完了します。 Azure Portal で Resource Health Center チェック再デプロイした後に専用ホストにデプロイされた VM の正常性を確認します。 詳細については、「https://docs.microsoft.com/azure/service-health/resource-health-overview」をご覧ください。

az vm host redeploy [--host-group]
                    [--host-name]
                    [--ids]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--resource-group]
                    [--subscription]

省略可能のパラメーター

--host-group --host-group-name

専用ホスト グループの名前。

--host-name --name -n

専用ホストの名前。

--ids

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 vm host resize

編集

専用ホストのサイズを変更します。

az vm host resize [--host-group]
                  [--host-name]
                  [--ids]
                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                  [--resource-group]
                  [--sku]
                  [--subscription]

例

専用ホストのサイズを変更します。

az vm host resize --host-group MyHostGroup --name MyHost --resource-group MyResourceGroup --sku-name DSv3-Type1

省略可能のパラメーター

--host-group --host-group-name

専用ホスト グループの名前。

--host-name --name -n

専用ホストの名前。

--ids

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--sku

サイズ変更用の専用ホスト サイズ。 サイズ変更に使用できる専用ホスト サイズは、'az vm host list-resize-options' を実行して一覧表示できます。

--subscription

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

グローバル パラメーター
--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 vm host restart

編集

専用ホストを再起動します。

専用ホストが再起動して実行されると、操作は正常に完了します。 再起動後に専用ホストにデプロイされた VM の正常性を判断するには、Azure Portal の Resource Health Center チェックします。 詳細については、「https://docs.microsoft.com/azure/service-health/resource-health-overview」をご覧ください。

az vm host restart [--host-group]
                   [--host-name]
                   [--ids]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]

省略可能のパラメーター

--host-group --host-group-name

専用ホスト グループの名前。

--host-name

専用ホストの名前。

--ids

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 vm host show

編集

専用ホストの詳細を取得します。

az vm host show [--expand {instanceView, userData}]
                [--host-group]
                [--host-name]
                [--ids]
                [--resource-group]
                [--subscription]

例

専用ホストの詳細を取得します。

az vm host show --host-group MyHostGroup --name MyDedicatedHost --resource-group MyResourceGroup

省略可能のパラメーター

--expand

操作に適用する展開式。 'InstanceView' は、専用ホストのインスタンス ビューの一覧を取得します。 'UserData' は専用ホストではサポートされていません。

指定可能な値: instanceView, userData
--host-group --host-group-name

専用ホスト グループの名前。

--host-name --name -n

専用ホストの名前。

--ids

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

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 vm host update

編集

専用ホストを更新します。

az vm host update [--add]
                  [--force-string]
                  [--host-group]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]

例

専用ホストの 'autoReplaceOnFailure' フィールドを更新します。

az vm host update --host-group my-host-group --name my-host \
    --resource-group my-resource-group --set autoReplaceOnFailure=True

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

規定値: []
--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False
--host-group

専用ホスト グループの名前。

--ids

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

--name -n

専用ホストの名前。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

規定値: []
--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

規定値: []
--subscription

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

グローバル パラメーター
--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 vm host wait

編集

条件が満たされるまで CLI を待機状態にします。

az vm host wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--expand {instanceView, userData}]
                [--host-group]
                [--host-name]
                [--ids]
                [--interval]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False
--exists

リソースが存在するまで待ちます。

規定値: False
--expand

操作に適用する展開式。 'InstanceView' は、専用ホストのインスタンス ビューの一覧を取得します。 'UserData' は専用ホストではサポートされていません。

指定可能な値: instanceView, userData
--host-group --host-group-name

専用ホスト グループの名前。

--host-name --name -n

専用ホストの名前。

--ids

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

--interval

ポーリング間隔 (秒単位)。

規定値: 30
--resource-group -g

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

--subscription

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

--timeout

最大待機時間 (秒単位)。

規定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: 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 を使います。