Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve README for #66 #67

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,12 +276,27 @@ $ az-pim-cli activate group --name my-entra-id-group --duration 5
$ az-pim-cli list roles
== my-entra-id-role ==
- Owner
- Contributor

# Activate the first matching role for the Entra role 'my-entra-id-role'
$ az-pim-cli activate role --name my-entra-id-role --duration 5
$ az-pim-cli activate role --name "my-entra-id-role" --duration 30
2024/05/31 15:00:10 Activating role 'Owner' for Entra role 'my-entra-id-role' with reason 'config' (ticket: [])
2024/05/31 15:00:23 The role 'Owner' for Entra role 'my-entra-id-role' is now Active

# Activate nominated role for the Entra role 'my-entra-id-role'
$ az-pim-cli activate role --name "my-entra-id-role" --role "Contributor" --duration 30
2024/05/31 15:00:10 Activating role 'Contributor' for Entra role 'my-entra-id-role' with reason 'config' (ticket: [])
2024/05/31 15:00:23 The role 'Contributor' for Entra role 'my-entra-id-role' is now Active
```
### Troubleshooting

#### Error: The following policy rules failed: [\"ExpirationRule\"]"

Make sure you set duration (e.g. --duration 30) when activate the group, resource or role.

#### Error: The following policy rules failed: [\"TicketingRule\"]"

Make sure you set ticket number (e.g. -T "ticket") when activate the group, resource or role.

### Configuration options

Expand Down