search

alan-turing-institute / data-safe-haven

https://data-safe-haven.readthedocs.io
BSD 3-Clause "New" or "Revised" License
50 stars 14 forks source link

Explain difference between Context key and name #1898

Open jemrobinson opened 1 month ago

jemrobinson commented 1 month ago

In dsh context add we should explain the difference between key and name and whether you'd like them to be the same or different.

╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    key      TEXT  Key of the context to add. [default: None] [required]                                                                                                                                                                                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --admin-group           TEXT  The ID of an Azure group containing all administrators. [default: None] [required]                                                                                                                                                        │
│ *  --location              TEXT  The Azure location to deploy resources into. [default: None] [required]                                                                                                                                                                   │
│ *  --name                  TEXT  The human friendly name to give this Data Safe Haven deployment. [default: None] [required]                                                                                                                                               │
│ *  --subscription          TEXT  The name of an Azure subscription to deploy resources into. [default: None] [required]                                                                                                                                                    │
│    --help          -h            Show this message and exit.                                                                                                                                                                                                               │
╰──────────────────────────────────────────────────────────────────────────────
JimMadge commented 1 month ago

@craddm and I spoke about this before.

key is for lookup in a dict. Name is a human readable name. Could map name->key, if we are confident we can avoid duplicates (or catch them if they occur!)