Skip to content

Added examples to cmdlets #1258

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 7, 2022
Merged

Added examples to cmdlets #1258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4d606c
Added examples to cmdlets
msewaweru May 13, 2022
d243b47
Merge branch 'dev' into pim-examples
peombwa Jun 7, 2022
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
91 changes: 82 additions & 9 deletions ...lment/examples/v1.0-beta/Get-MgRoleManagementDirectoryRoleAssignmentSchedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,91 @@
### Example 1: {{ Add title here }}
### Example 1: Get all assignment schedules

```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleAssignmentSchedule | Format-List

ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilitySchedule
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Assigned
CreatedDateTime :
CreatedUsing :
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 4-PYiFWPHkqVOpuYmLiHa_CWtrDUYhRNsQq0vuB-N3E-1
MemberType : Direct
ModifiedDateTime :
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : b0b696f0-62d4-4d14-b10a-b4bee07e3771
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}

{{ Add output here }}
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilitySchedule
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Activated
CreatedDateTime : 5/13/2022 8:14:33 AM
CreatedUsing : 76dd76bb-900f-470b-9bcc-1eb68bc45532
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 76dd76bb-900f-470b-9bcc-1eb68bc45532
MemberType : Direct
ModifiedDateTime :
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}
```

{{ Add description here }}
This example gets all active role assignment schedules. This includes active roles assignments that have been created and the future scheduled assignments.

### Example 2: Get all assignment schedules for a user

### Example 2: {{ Add title here }}
```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleAssignmentSchedule -Filter "principalId eq '6c42590f-fcf0-4922-bac6-205f7c6aa89c'”

{{ Add output here }}
```
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilitySchedule
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Activated
CreatedDateTime : 5/13/2022 8:14:33 AM
CreatedUsing : 76dd76bb-900f-470b-9bcc-1eb68bc45532
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 76dd76bb-900f-470b-9bcc-1eb68bc45532
MemberType : Direct
ModifiedDateTime :
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}

{{ Add description here }}
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilitySchedule
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Assigned
CreatedDateTime : 5/13/2022 8:33:37 AM
CreatedUsing : 9e98256e-58af-4d02-89ce-5134e2fe5508
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 9e98256e-58af-4d02-89ce-5134e2fe5508
MemberType : Direct
ModifiedDateTime :
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 9360feb5-f418-4baa-8175-e2a00bac4301
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}
```

This example gets all active role assignment schedules for a user.
87 changes: 78 additions & 9 deletions ...amples/v1.0-beta/Get-MgRoleManagementDirectoryRoleAssignmentScheduleInstance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,87 @@
### Example 1: {{ Add title here }}
### Example 1: Get all role assignment schedule instances

```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleAssignmentScheduleInstance | Format-List

ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilityScheduleInstance
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Assigned
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
EndDateTime :
Id : 4-PYiFWPHkqVOpuYmLiHa_CWtrDUYhRNsQq0vuB-N3E-1
MemberType : Direct
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : b0b696f0-62d4-4d14-b10a-b4bee07e3771
RoleAssignmentOriginId : 4-PYiFWPHkqVOpuYmLiHa_CWtrDUYhRNsQq0vuB-N3E-1
RoleAssignmentScheduleId : 4-PYiFWPHkqVOpuYmLiHa_CWtrDUYhRNsQq0vuB-N3E-1
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
StartDateTime :
AdditionalProperties : {}

ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilityScheduleInstance
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Activated
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
EndDateTime : 5/13/2022 11:14:32 AM
Id : 4-PYiFWPHkqVOpuYmLiHaw9ZQmzw_CJJusYgX3xqqJw-1
MemberType : Direct
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleAssignmentOriginId : 4-PYiFWPHkqVOpuYmLiHaw9ZQmzw_CJJusYgX3xqqJw-1
RoleAssignmentScheduleId : 76dd76bb-900f-470b-9bcc-1eb68bc45532
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
StartDateTime : 5/13/2022 8:14:33 AM
AdditionalProperties : {}

{{ Add output here }}
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilityScheduleInstance
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Assigned
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
EndDateTime :
Id : lAPpYvVpN0KRkAEhdxReEENupG7coEFEgfvZ4yNW5ic-1
MemberType : Direct
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6ea46e43-a0dc-4441-81fb-d9e32356e627
RoleAssignmentOriginId : lAPpYvVpN0KRkAEhdxReEENupG7coEFEgfvZ4yNW5ic-1
RoleAssignmentScheduleId : lAPpYvVpN0KRkAEhdxReEENupG7coEFEgfvZ4yNW5ic-1
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 62e90394-69f5-4237-9190-012177145e10
StartDateTime :
AdditionalProperties : {}
```

{{ Add description here }}
This examples get all created active role assignments.

### Example 2: Get all role assignment schedule instances for a user

### Example 2: {{ Add title here }}
```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleAssignmentScheduleInstance -Filter "principalId eq '6c42590f-fcf0-4922-bac6-205f7c6aa89c'" | Format-List

{{ Add output here }}
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilityScheduleInstance
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
AssignmentType : Activated
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
EndDateTime : 5/13/2022 11:14:32 AM
Id : 4-PYiFWPHkqVOpuYmLiHaw9ZQmzw_CJJusYgX3xqqJw-1
MemberType : Direct
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleAssignmentOriginId : 4-PYiFWPHkqVOpuYmLiHaw9ZQmzw_CJJusYgX3xqqJw-1
RoleAssignmentScheduleId : 76dd76bb-900f-470b-9bcc-1eb68bc45532
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
StartDateTime : 5/13/2022 8:14:33 AM
AdditionalProperties : {}
```

{{ Add description here }}

This examples get all created active role assignments for the specified user.
65 changes: 56 additions & 9 deletions ...xamples/v1.0-beta/Get-MgRoleManagementDirectoryRoleAssignmentScheduleRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,65 @@
### Example 1: {{ Add title here }}
### Example 1: Get all active role assignment requests

```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleAssignmentScheduleRequest | Format-List

{{ Add output here }}
Action : SelfActivate
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilitySchedule
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
ApprovalId :
CompletedDateTime : 5/13/2022 8:14:32 AM
CreatedBy : Microsoft.Graph.PowerShell.Models.MicrosoftGraphIdentitySet
CreatedDateTime : 5/13/2022 8:14:32 AM
CustomData :
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 76dd76bb-900f-470b-9bcc-1eb68bc45532
IsValidationOnly : False
Justification : Activate assignment
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
TargetSchedule : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleAssignmentSchedule
TargetScheduleId : 76dd76bb-900f-470b-9bcc-1eb68bc45532
TicketInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphTicketInfo
AdditionalProperties : {}
```

{{ Add description here }}
This example gets all the active role assignment requests.

### Example 2: Get all active role assignment requests for a user

### Example 2: {{ Add title here }}
```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleAssignmentScheduleRequest -Filter "principalId eq '6c42590f-fcf0-4922-bac6-205f7c6aa89c'" | Format-List

{{ Add output here }}
Action : SelfActivate
ActivatedUsing : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleEligibilitySchedule
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
ApprovalId :
CompletedDateTime : 5/13/2022 8:14:32 AM
CreatedBy : Microsoft.Graph.PowerShell.Models.MicrosoftGraphIdentitySet
CreatedDateTime : 5/13/2022 8:14:32 AM
CustomData :
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 76dd76bb-900f-470b-9bcc-1eb68bc45532
IsValidationOnly : False
Justification : Activate assignment
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
TargetSchedule : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleAssignmentSchedule
TargetScheduleId : 76dd76bb-900f-470b-9bcc-1eb68bc45532
TicketInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphTicketInfo
AdditionalProperties : {}
```

{{ Add description here }}

This example gets all the active role assignment requests for the specified user.
66 changes: 57 additions & 9 deletions ...ment/examples/v1.0-beta/Get-MgRoleManagementDirectoryRoleEligibilitySchedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,66 @@
### Example 1: {{ Add title here }}
### Example 1: Get all eligibility schedules

```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleEligibilitySchedule | Format-List

AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
CreatedDateTime : 2/15/2022 3:11:22 PM
CreatedUsing : 78222acb-04d0-4f9f-9d5e-52fb75658d32
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 78222acb-04d0-4f9f-9d5e-52fb75658d32
MemberType : Direct
ModifiedDateTime : 1/1/0001 8:00:00 AM
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 50a2bbd7-302c-4572-b6b0-7c8cc0bce7b7
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 9b895d92-2cd3-44c7-9d02-a6ac2d5ea5c3
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}

{{ Add output here }}
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
CreatedDateTime : 5/13/2022 7:39:08 AM
CreatedUsing : 8554c1e7-b359-41b9-802e-4beabddec142
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 8554c1e7-b359-41b9-802e-4beabddec142
MemberType : Direct
ModifiedDateTime : 1/1/0001 8:00:00 AM
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}
```

{{ Add description here }}
This example returns all eligible role assignment schedules. This includes eligible roles that have been created and the future scheduled assignments.

### Example 2: Get all eligibility schedules for specific user

### Example 2: {{ Add title here }}
```powershell
PS C:\> {{ Add code here }}
Get-MgRoleManagementDirectoryRoleEligibilitySchedule -Filter "principalId eq '6c42590f-fcf0-4922-bac6-205f7c6aa89c'" | Format-List

{{ Add output here }}
AppScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAppScope
AppScopeId :
CreatedDateTime : 5/13/2022 7:39:08 AM
CreatedUsing : 8554c1e7-b359-41b9-802e-4beabddec142
DirectoryScope : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
DirectoryScopeId : /
Id : 8554c1e7-b359-41b9-802e-4beabddec142
MemberType : Direct
ModifiedDateTime : 1/1/0001 8:00:00 AM
Principal : Microsoft.Graph.PowerShell.Models.MicrosoftGraphDirectoryObject
PrincipalId : 6c42590f-fcf0-4922-bac6-205f7c6aa89c
RoleDefinition : Microsoft.Graph.PowerShell.Models.MicrosoftGraphUnifiedRoleDefinition
RoleDefinitionId : 88d8e3e3-8f55-4a1e-953a-9b9898b8876b
ScheduleInfo : Microsoft.Graph.PowerShell.Models.MicrosoftGraphRequestSchedule
Status : Provisioned
AdditionalProperties : {}
```

{{ Add description here }}

This example returns all eligible role assignment schedules for the specified user.
Loading