az network bastion

Note

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

Azure Bastion ホスト マシンを管理します。

コマンド

名前 説明 状態
az network bastion create

Azure Bastion ホスト マシンを作成します。

拡張子 プレビュー
az network bastion delete

Azure Bastion ホスト コンピューターを削除します。

拡張子 プレビュー
az network bastion list

すべての Azure Bastion ホスト マシンを一覧表示します。

拡張子 プレビュー
az network bastion rdp

Azure Bastion からのトンネリングを使用して仮想マシンをターゲットにする RDP。

拡張子 GA
az network bastion show

Azure Bastion ホスト マシンを表示します。

拡張子 プレビュー
az network bastion ssh

Azure Bastion からのトンネリングを使用して仮想マシンに SSH 接続します。

拡張子 GA
az network bastion tunnel

Azure Bastion 経由でターゲット仮想マシンへのトンネルを開きます。

拡張子 GA
az network bastion update

Azure Bastion ホスト コンピューターを更新します。

拡張子 プレビュー
az network bastion wait

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

拡張子 GA

az network bastion create

プレビュー

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

Azure Bastion ホスト マシンを作成します。

az network bastion create --name
                          --public-ip-address
                          --resource-group
                          --vnet-name
                          [--disable-copy-paste {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-ip-connect {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tunneling {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--scale-units]
                          [--sku {Basic, Standard}]
                          [--tags]

Azure Bastion ホスト マシンを作成します。

az network bastion create --location westus2 --name MyBastionHost --public-ip-address MyPublicIpAddress --resource-group MyResourceGroup --vnet-name MyVnet

必須のパラメーター

--name -n

要塞ホストの名前。

--public-ip-address

Azure パブリック IP の名前または ID。 パブリック IP の SKU は Standard である必要があります。

--resource-group -g

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

--vnet-name

仮想ネットワークの名前。 AzureBastionSubnet というサブネットが必要です。

省略可能のパラメーター

--disable-copy-paste

この Azure Bastion リソースのすべてのセッションのコピーと貼り付けを無効にします。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
規定値: False
--enable-ip-connect

この Azure Bastion リソースで IP ベースの接続を有効にします。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
規定値: False
--enable-tunneling

この Azure Bastion リソースでネイティブ クライアント サポートを有効にします。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
規定値: False
--location -l

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--scale-units

[2, 50] の範囲の Bastion Host リソースのスケール ユニット。

--sku

この Bastion ホストの SKU。

指定可能な値: Basic, Standard
規定値: Standard
--tags

スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

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

プレビュー

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

Azure Bastion ホスト コンピューターを削除します。

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

Azure Bastion ホスト コンピューターを削除します。

az network bastion delete --name MyBastionHost --resource-group MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

要塞ホストの名前。

--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 network bastion list

プレビュー

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

すべての Azure Bastion ホスト マシンを一覧表示します。

az network bastion list [--resource-group]

すべての Azure Bastion ホスト マシンを一覧表示します。

az network bastion list -g MyResourceGroup

省略可能のパラメーター

--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 network bastion rdp

Azure Bastion からのトンネリングを使用して仮想マシンをターゲットにする RDP。

az network bastion rdp [--auth-type]
                       [--configure]
                       [--disable-gateway {false, true}]
                       [--enable-mfa {false, true}]
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--resource-port]
                       [--subscription]
                       [--target-ip-address]
                       [--target-resource-id]

Azure Bastion を使用して仮想マシンに RDP 接続します。

az network bastion rdp --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId

到達可能な IP アドレスを使用してマシンに RDP 接続します。

az network bastion rdp --name MyBastionHost --resource-group MyResourceGroup --target-ip-address 10.0.0.1

省略可能のパラメーター

--auth-type

RDP 接続に使用する認証の種類。

--configure

RDP セッションを構成するためのフラグ。

規定値: False
--disable-gateway

RD ゲートウェイ経由のアクセスを無効にするフラグ。

指定可能な値: false, true
規定値: False
--enable-mfa

ターゲット コンピューターでサポートされている場合は、MFA を使用して認証する新しいプロトコルを使用して、AAD が有効になっている Windows マシンにログインします。 Windows 10 20H2 以降、Windows 11 21H2 以降、WS 2022 で使用できます。

指定可能な値: false, true
規定値: False
--ids

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

--name -n

要塞ホストの名前。

--resource-group -g

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

--resource-port

要塞が接続するターゲット VM のリソース ポート。

--subscription

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

--target-ip-address

ターゲット仮想マシンの IP アドレス。

--target-resource-id

ターゲット仮想マシンの ResourceId。

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

プレビュー

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

Azure Bastion ホスト マシンを表示します。

az network bastion show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Azure Bastion ホスト マシンを表示します。

az network bastion show --name MyBastionHost --resource-group MyResourceGroup

省略可能のパラメーター

--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 network bastion ssh

Azure Bastion からのトンネリングを使用して仮想マシンに SSH 接続します。

az network bastion ssh --auth-type
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--resource-port]
                       [--ssh-key]
                       [--subscription]
                       [--target-ip-address]
                       [--target-resource-id]
                       [--username]
                       [<SSH_ARGS>]

パスワードを使用して Azure Bastion を使用して仮想マシンに SSH 接続します。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type password --username xyz

ssh キー ファイルを使用して Azure Bastion を使用して仮想マシンに SSH 接続します。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type ssh-key --username xyz --ssh-key C:/filepath/sshkey.pem

AAD を使用して Azure Bastion を使用して仮想マシンに SSH 接続します。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type AAD

追加の SSH 引数を指定しながら、AAD を使用して Azure Bastion を使用して仮想マシンに SSH 接続します。

az network bastion ssh --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --auth-type AAD -- -L 8080:127.0.0.1:8080

必須のパラメーター

--auth-type

SSH 接続に使用する認証の種類。

省略可能のパラメーター

--ids

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

--name -n

要塞ホストの名前。

--resource-group -g

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

--resource-port

要塞が接続するターゲット VM のリソース ポート。

--ssh-key

SSH 接続の SSH キー ファイルの場所。

--subscription

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

--target-ip-address

ターゲット仮想マシンの IP アドレス。

--target-resource-id

ターゲット仮想マシンの ResourceId。

--username

SSH 接続のユーザー名。

<SSH_ARGS>

OpenSSH に渡される追加の引数。

グローバル パラメーター
--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 network bastion tunnel

Azure Bastion 経由でターゲット仮想マシンへのトンネルを開きます。

az network bastion tunnel --port
                          --resource-port
                          [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--target-ip-address]
                          [--target-resource-id]
                          [--timeout]

resourceId を使用して、Azure Bastion 経由でターゲット仮想マシンへのトンネルを開きます。

az network bastion tunnel --name MyBastionHost --resource-group MyResourceGroup --target-resource-id vmResourceId --resource-port 22 --port 50022

IP アドレスを使用して、Azure Bastion 経由でターゲット仮想マシンへのトンネルを開きます。

az network bastion tunnel --name MyBastionHost --resource-group MyResourceGroup --target-ip-address 10.0.0.1 --resource-port 22 --port 50022

必須のパラメーター

--port

トンネリングに使用するローカル ポート。

--resource-port

要塞が接続するターゲット VM のリソース ポート。

省略可能のパラメーター

--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 を使用して、既定のサブスクリプションを構成できます。

--target-ip-address

ターゲット仮想マシンの IP アドレス。

--target-resource-id

ターゲット仮想マシンの ResourceId。

--timeout

要塞ホスト トンネルへの接続のタイムアウト。

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

プレビュー

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

Azure Bastion ホスト コンピューターを更新します。

az network bastion update [--add]
                          [--disable-copy-paste {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-ip-connect {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tunneling {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--remove]
                          [--resource-group]
                          [--scale-units]
                          [--set]
                          [--sku {Basic, Standard}]
                          [--subscription]

ネイティブ クライアントのサポートを有効にするために、Azure Bastion ホスト マシンを更新します。

az network bastion update --name MyBastionHost --resource-group MyResourceGroup --enable-tunneling

省略可能のパラメーター

--add

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

--disable-copy-paste

この Azure Bastion リソースのすべてのセッションのコピーと貼り付けを無効にします。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--enable-ip-connect

この Azure Bastion リソースで IP ベースの接続を有効にします。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--enable-tunneling

この Azure Bastion リソースでネイティブ クライアント サポートを有効にします。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--force-string

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

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

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

--name -n

要塞ホストの名前。

--no-wait

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

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

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

--resource-group -g

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

--scale-units

[2, 50] の範囲の Bastion Host リソースのスケール ユニット。

--set

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

--sku

この Bastion ホストの SKU。

指定可能な値: Basic, Standard
--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 network bastion wait

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

az network bastion wait [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

省略可能のパラメーター

--created

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

規定値: False
--custom

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

--deleted

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

規定値: False
--exists

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

規定値: False
--ids

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

--interval

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

規定値: 30
--name -n

要塞ホストの名前。

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