az batch node user

  • リファレンス

Batch コンピューティング ノードのユーザー アカウントを管理します。

コマンド

名前 説明 型 Status
az batch node user create

Batch コンピューティング ノードにユーザー アカウントを追加します。

 コア GA
az batch node user delete

指定したコンピューティング ノードからユーザー アカウントを削除します。

 コア GA
az batch node user reset

Batch コンピューティング ノードのユーザー アカウントのプロパティを更新します。 更新できる未指定のプロパティは、既定値にリセットされます。

 コア GA

az batch node user create

編集

Batch コンピューティング ノードにユーザー アカウントを追加します。

az batch node user create --node-id
                          --pool-id
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--expiry-time]
                          [--is-admin]
                          [--json-file]
                          [--name]
                          [--password]
                          [--ssh-public-key]

必須のパラメーター

--node-id

ユーザー アカウントを作成するコンピューターの ID。

--pool-id

コンピューティング ノードを含むプールの ID。

省略可能のパラメーター

--account-endpoint

Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--expiry-time

省略した場合、既定値は現在の時刻から 1 日です。 Linux コンピューティング ノードの場合、expiryTime には最大 1 日の有効桁数があります。 予期される形式は ISO-8601 タイムスタンプです。

--is-admin

アカウントがコンピューティング ノードの管理者である必要があるかどうか。 既定値は false です。 True の場合フラグが存在します。

--json-file

JSON のユーザー仕様を含むファイル (それぞれの REST API 本文に一致するように書式設定)。 このパラメーターを指定すると、すべての 'User Arguments' は無視されます。

--name

必須。

--password

パスワードは、Windows コンピューティング ノード ('cloudServiceConfiguration' で作成されたもの、または Windows イメージ参照を使用して 'virtualMachineConfiguration' で作成されたもの) に必要です。 Linux コンピューティング ノードの場合、必要に応じて sshPublicKey プロパティと共にパスワードを指定できます。

--ssh-public-key

公開キーは OpenSSH エンコードと互換性があり、Base 64 でエンコードする必要があります。 このプロパティは、Linux コンピューティング ノードに対してのみ指定できます。 これが Windows コンピューティング ノードに対して指定されている場合、Batch サービスは要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

グローバル パラメーター
--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 batch node user delete

編集

指定したコンピューティング ノードからユーザー アカウントを削除します。

コンピューティング ノードに対するユーザー アカウントは、アイドル状態または実行中の状態の場合にのみ削除できます。

az batch node user delete --node-id
                          --pool-id
                          --user-name
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--yes]

必須のパラメーター

--node-id

ユーザー アカウントを削除するコンピューターの ID。

--pool-id

コンピューティング ノードを含むプールの ID。

--user-name

削除するユーザー アカウントの名前。

省略可能のパラメーター

--account-endpoint

Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--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 batch node user reset

編集

Batch コンピューティング ノードのユーザー アカウントのプロパティを更新します。 更新できる未指定のプロパティは、既定値にリセットされます。

az batch node user reset --node-id
                         --pool-id
                         --user-name
                         [--account-endpoint]
                         [--account-key]
                         [--account-name]
                         [--expiry-time]
                         [--json-file]
                         [--password]
                         [--ssh-public-key]

必須のパラメーター

--node-id

ユーザー アカウントを更新するコンピューターの ID。

--pool-id

コンピューティング ノードを含むプールの ID。

--user-name

更新するユーザー アカウントの名前。

省略可能のパラメーター

--account-endpoint

Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--expiry-time

省略した場合、既定値は現在の時刻から 1 日です。 Linux コンピューティング ノードの場合、expiryTime には最大 1 日の有効桁数があります。 予期される形式は ISO-8601 タイムスタンプです。

--json-file

ノードを含むファイルは、JSON のユーザー パラメーター仕様を更新します (それぞれの REST API 本文に一致するように書式設定されます)。 このパラメーターを指定すると、すべての 'Node Update User Arguments' は無視されます。

--password

パスワードは、Windows コンピューティング ノード ('cloudServiceConfiguration' で作成されたもの、または Windows イメージ参照を使用して 'virtualMachineConfiguration' で作成されたもの) に必要です。 Linux コンピューティング ノードの場合、必要に応じて sshPublicKey プロパティと共にパスワードを指定できます。 省略すると、既存のパスワードが削除されます。

--ssh-public-key

公開キーは OpenSSH エンコードと互換性があり、Base 64 でエンコードする必要があります。 このプロパティは、Linux コンピューティング ノードに対してのみ指定できます。 これが Windows コンピューティング ノードに対して指定されている場合、Batch サービスは要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 省略すると、既存の SSH 公開キーが削除されます。

グローバル パラメーター
--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 を使います。