az batch node user
Batch コンピューティング ノードのユーザー アカウントを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az batch node user create |
Batch コンピューティング ノードにユーザー アカウントを追加します。 |
Core | GA |
| az batch node user delete |
指定したコンピューティング ノードからユーザー アカウントを削除します。 |
Core | GA |
| az batch node user reset |
Batch コンピューティング ノードのユーザー アカウントのプロパティを更新します。 更新できる未指定のプロパティは、既定値にリセットされます。 |
Core | GA |
az batch node user create
Batch コンピューティング ノードにユーザー アカウントを追加します。
az batch node user create --node-id
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--acquire-policy-token]
[--change-reference]
[--expiry-time]
[--is-admin]
[--json-file]
[--name]
[--password]
[--ssh-public-key]
例
SSH 公開キーを使用して、通常の (管理者以外の) ユーザーを作成します。
az batch node user create --pool-id pool1 --node-id node1 --name example_user --ssh-public-key example_public_key
必須のパラメーター
ユーザー アカウントを作成するコンピューターの ID。 Required.
コンピューティング ノードを含むプールの ID。 Required.
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
アカウントの有効期限が切れる時刻。 省略した場合、既定値は現在の時刻から 1 日です。 Linux コンピューティング ノードの場合、expiryTime には最大 1 日の有効桁数があります。 予期される形式は ISO-8601 タイムスタンプです。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | User Arguments |
アカウントがコンピューティング ノードの管理者である必要があるかどうか。 既定値は false です。 True の場合フラグが存在します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | User Arguments |
JSON のユーザー仕様を含むファイル (それぞれの REST API 本文に一致するように書式設定)。 このパラメーターを指定すると、すべての 'User Arguments' は無視されます。
アカウントのユーザー名。 Required.
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | User Arguments |
アカウントのパスワード。 このパスワードは、Windows コンピューティング ノード (Windows イメージ参照を使用して 'virtualMachineConfiguration' で作成されたもの) に必要です。 Linux コンピューティング ノードの場合、必要に応じて sshPublicKey プロパティと共にパスワードを指定できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | User Arguments |
コンピューティング ノードへのリモート ログインに使用できる SSH 公開キー。 公開キーは OpenSSH エンコードと互換性があり、Base 64 でエンコードする必要があります。 このプロパティは、Linux コンピューティング ノードに対してのみ指定できます。 これが Windows コンピューティング ノードに対して指定されている場合、Batch サービスは要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) になります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | User Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az batch node user delete
指定したコンピューティング ノードからユーザー アカウントを削除します。
コンピューティング ノードに対するユーザー アカウントは、アイドル状態または実行中の状態の場合にのみ削除できます。
az batch node user delete --node-id
--pool-id
--user-name
[--account-endpoint]
[--account-key]
[--account-name]
[--acquire-policy-token]
[--change-reference]
[--yes]
必須のパラメーター
ユーザー アカウントを削除するコンピューターの ID。 Required.
コンピューティング ノードを含むプールの ID。 Required.
削除するユーザー アカウントの名前。 Required.
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
確認を求めないでください。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az batch node user reset
Batch コンピューティング ノードのユーザー アカウントのプロパティを更新します。 更新できる未指定のプロパティは、既定値にリセットされます。
az batch node user reset --node-id
--pool-id
--user-name
[--account-endpoint]
[--account-key]
[--account-name]
[--acquire-policy-token]
[--change-reference]
[--expiry-time]
[--json-file]
[--password]
[--ssh-public-key]
例
既存のユーザーに新しい SSH 公開キーを設定し、他のすべてのプロパティを既定値にリセットします。
az batch node user reset --pool-id pool1 --node-id node1 --user-name example_user --ssh-public-key new_public_key
必須のパラメーター
ユーザー アカウントを更新するコンピューターの ID。 Required.
コンピューティング ノードを含むプールの ID。 Required.
更新するユーザー アカウントの名前。 Required.
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Batch Account Arguments |
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
アカウントの有効期限が切れる時刻。 省略した場合、既定値は現在の時刻から 1 日です。 Linux コンピューティング ノードの場合、expiryTime には最大 1 日の有効桁数があります。 予期される形式は ISO-8601 タイムスタンプです。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Content Arguments |
JSON のコンテンツ仕様を含むファイル (それぞれの REST API 本文に一致するように書式設定)。 このパラメーターを指定すると、すべての 'Content Arguments' は無視されます。
アカウントのパスワード。 このパスワードは、Windows コンピューティング ノード (Windows イメージ参照を使用して 'virtualMachineConfiguration' で作成されたもの) に必要です。 Linux コンピューティング ノードの場合、必要に応じて sshPublicKey プロパティと共にパスワードを指定できます。 省略すると、既存のパスワードが削除されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Content Arguments |
コンピューティング ノードへのリモート ログインに使用できる SSH 公開キー。 公開キーは OpenSSH エンコードと互換性があり、Base 64 でエンコードする必要があります。 このプロパティは、Linux コンピューティング ノードに対してのみ指定できます。 これが Windows コンピューティング ノードに対して指定されている場合、Batch サービスは要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) になります。 省略すると、既存の SSH 公開キーが削除されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Content Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |