次の方法で共有

az arcgateway

  • リファレンス

注

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

Arc マシンでゲートウェイ接続を管理します。

コマンド

名前 説明 型 状態
az arcgateway create

Arc ゲートウェイ リソースを作成します。

 拡張 GA
az arcgateway delete

Arc ゲートウェイ リソースを削除します。

 拡張 GA
az arcgateway list

特定のサブスクリプションに関連付けられているすべての Arc ゲートウェイ リソースを一覧表示します。

 拡張 GA
az arcgateway settings

Azure Arc-Enabled Server の設定を管理します。

 拡張 GA
az arcgateway settings update

ターゲット リソースの基本設定を更新します。

 拡張 GA
az arcgateway show

特定の Arc ゲートウェイ リソースの詳細を表示します。

 拡張 GA
az arcgateway wait

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

 拡張 GA

az arcgateway create

Arc ゲートウェイ リソースを作成します。

az arcgateway create --gateway-name --name
                     --resource-group
                     [--allowed-features]
                     [--gateway-type {Public}]
                     [--___location]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--tags]

例

ゲートウェイ作成のサンプル コマンド

az arcgateway create --name MyArcgateway --resource-group myResourceGroup --___location eastus2euap --subscription mySubscription

必須のパラメーター

--gateway-name --name -n

ゲートウェイの名前。

--resource-group -g

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

省略可能のパラメーター

--allowed-features

このゲートウェイで有効になっている機能の一覧を指定します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

規定値: ['*']
--gateway-type

ゲートウェイ リソースの種類。

指定可能な値: Public
--___location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

--no-wait

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

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

リソース タグ。 短縮構文、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 arcgateway delete

Arc ゲートウェイ リソースを削除します。

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

例

コマンドまたはゲートウェイの削除のサンプル

az arcgateway delete --name MyArcgateway --resource-group myResourceGroup --subscription mySubscription

省略可能のパラメーター

--gateway-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 arcgateway list

特定のサブスクリプションに関連付けられているすべての Arc ゲートウェイ リソースを一覧表示します。

az arcgateway list [--max-items]
                   [--next-token]
                   [--resource-group]

例

コマンドまたはゲートウェイの一覧のサンプル

az arcgateway list --subscription mySubscription

省略可能のパラメーター

--max-items

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

--next-token

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

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

特定の Arc ゲートウェイ リソースの詳細を表示します。

az arcgateway show [--gateway-name --name]
                   [--ids]
                   [--resource-group]
                   [--subscription]

例

ゲートウェイ ショーのサンプル コマンド

az arcgateway show --name myArcgateway --resource-group myResourceGroup --subscription mySubscription

省略可能のパラメーター

--gateway-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 arcgateway wait

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

az arcgateway wait [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--gateway-name --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
--gateway-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 を使用します。