users#

dsh users commands are used to manage users on the Entra ID associated with a DSH deployment.

users#

users Usage: dsh users [OPTIONS] COMMAND [ARGS]... ╭─ Options ─────────────────────────────────────────────────────╮ --install-completionInstall completion for the      current shell.                  --show-completionShow completion for the current shell, to copy it or customize  the installation.               --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────╮ add        Add users to a deployed Data Safe Haven.         list       List users from a deployed Data Safe Haven.      register   Register existing users with a deployed SRE.     remove     Remove existing users from a deployed Data Safe  Haven.                                           unregister Unregister existing users from a deployed SRE.   ╰───────────────────────────────────────────────────────────────╯

add#

add Usage: dsh users add [OPTIONS] CSV Add users to a deployed Data Safe Haven. ╭─ Arguments ───────────────────────────────────────────────────╮ *csvPATHA CSV file containing details of users to add.                                      [default: None]                           [required]                                ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯

list#

list Usage: dsh users list [OPTIONS] SRE List users from a deployed Data Safe Haven. ╭─ Arguments ───────────────────────────────────────────────────╮ *sreTEXTThe name of the SRE to list users from. [default: None]                         [required]                              ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯

register#

register Usage: dsh users register [OPTIONS] SRE Register existing users with a deployed SRE. ╭─ Arguments ───────────────────────────────────────────────────╮ *sreTEXTThe name of the SRE to add the users to. [default: None]                          [required]                               ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ *--username-uTEXTUsername of a user to register   with this SRE. [*may be          specified several times*]        [default: None]                  [required]                       --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯

remove#

remove Usage: dsh users remove [OPTIONS] Remove existing users from a deployed Data Safe Haven. ╭─ Options ─────────────────────────────────────────────────────╮ *--username-uTEXTUsername of a user to remove     from this Data Safe Haven. [*may be specified several times*]     [default: None]                  [required]                       --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯

unregister#

unregister Usage: dsh users unregister [OPTIONS] SRE Unregister existing users from a deployed SRE. ╭─ Arguments ───────────────────────────────────────────────────╮ *sreTEXTThe name of the SRE to unregister the     users from.                               [default: None]                           [required]                                ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ *--username-uTEXTUsername of a user to unregister from this SRE. [*may be          specified several times*]        [default: None]                  [required]                       --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯