From c9415baa8b27df9e57ac68aabdc410912f90bf65 Mon Sep 17 00:00:00 2001 From: Eunice Waweru <73849846+msewaweru@users.noreply.github.com> Date: Thu, 15 Sep 2022 13:56:49 +0300 Subject: [PATCH 1/3] Added examples to Entitlement management v1.0 cmdlets --- ...et-MgEntitlementManagementAccessPackage.md | 12 ++--- ...et-MgEntitlementManagementAccessPackage.md | 47 +++++++++++++++---- ...titlementManagementAccessPackageCatalog.md | 5 +- .../Get-MgEntitlementManagementCatalog.md | 37 +++++++++++---- .../Get-MgEntitlementManagementSetting.md | 19 +++----- ...ew-MgEntitlementManagementAccessPackage.md | 33 ++++++++----- 6 files changed, 102 insertions(+), 51 deletions(-) diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0-beta/Get-MgEntitlementManagementAccessPackage.md b/src/Identity.Governance/Identity.Governance/examples/v1.0-beta/Get-MgEntitlementManagementAccessPackage.md index 9e31bf6656e..ce45e9a7fc5 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0-beta/Get-MgEntitlementManagementAccessPackage.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0-beta/Get-MgEntitlementManagementAccessPackage.md @@ -9,7 +9,7 @@ AccessPackageCatalog : Microsoft.Graph.PowerShell.Models.MicrosoftGra AccessPackageResourceRoleScopes : AccessPackagesIncompatibleWith : CatalogId : 54152ecb-c65d-47f2-8a4d-ba2732de0a7b -CreatedBy : admin@M365x814237.onmicrosoft.com +CreatedBy : Contoso.onmicrosoft.com CreatedDateTime : 11/5/2021 8:03:39 AM Description : DisplayName : Marketing Campaign @@ -18,7 +18,7 @@ IncompatibleAccessPackages : IncompatibleGroups : IsHidden : False IsRoleScopesVisible : False -ModifiedBy : admin@M365x814237.onmicrosoft.com +ModifiedBy : Contoso.onmicrosoft.com ModifiedDateTime : 11/5/2021 9:08:44 AM AdditionalProperties : {} @@ -27,7 +27,7 @@ AccessPackageCatalog : Microsoft.Graph.PowerShell.Models.MicrosoftGra AccessPackageResourceRoleScopes : AccessPackagesIncompatibleWith : CatalogId : 54152ecb-c65d-47f2-8a4d-ba2732de0a7b -CreatedBy : admin@M365x814237.onmicrosoft.com +CreatedBy : Contoso.onmicrosoft.com CreatedDateTime : 9/15/2021 7:23:44 AM Description : Access for Sales and Marketing users and guests DisplayName : Sales and Marketing @@ -36,7 +36,7 @@ IncompatibleAccessPackages : IncompatibleGroups : IsHidden : False IsRoleScopesVisible : False -ModifiedBy : admin@M365x814237.onmicrosoft.com +ModifiedBy : Contoso.onmicrosoft.com ModifiedDateTime : 9/15/2021 7:23:44 AM AdditionalProperties : {} ``` @@ -55,7 +55,7 @@ AccessPackageCatalog : Microsoft.Graph.PowerShell.Models.MicrosoftGra AccessPackageResourceRoleScopes : AccessPackagesIncompatibleWith : CatalogId : 54152ecb-c65d-47f2-8a4d-ba2732de0a7b -CreatedBy : admin@M365x814237.onmicrosoft.com +CreatedBy : Contoso.onmicrosoft.com CreatedDateTime : 11/5/2021 8:03:39 AM Description : DisplayName : Marketing Campaign @@ -64,7 +64,7 @@ IncompatibleAccessPackages : IncompatibleGroups : IsHidden : False IsRoleScopesVisible : False -ModifiedBy : admin@M365x814237.onmicrosoft.com +ModifiedBy : Contoso.onmicrosoft.com ModifiedDateTime : 11/5/2021 9:08:44 AM AdditionalProperties : {[@odata.context, https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/accessPackages/$entity]} diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackage.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackage.md index 093355d11d5..dac7bb6ea29 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackage.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackage.md @@ -1,18 +1,47 @@ -### Example 1: {{ Add title here }} +### Example 1: Get a list of all access packages + ```powershell -PS C:\> {{ Add code here }} +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' +Get-MgEntitlementManagementAccessPackage | Format-List + +AssignmentPolicies : +Catalog : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageCatalog1 +CreatedDateTime : 5/4/2022 10:02:17 AM +Description : +DisplayName : Marketing Campaign +Id : 5c17e2d4-b421-4c32-ac09-8b96cddd3042 +IsHidden : False +ModifiedDateTime : 5/4/2022 10:07:59 AM +AdditionalProperties : {} -{{ Add output here }} +AssignmentPolicies : +Catalog : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageCatalog1 +CreatedDateTime : 1/13/2022 6:48:14 AM +Description : Access for Sales and Marketing users and guests +DisplayName : Sales and Marketing +Id : 3f367184-5e17-47d6-b505-4cb43b471875 +IsHidden : False +ModifiedDateTime : 1/13/2022 6:48:14 AM +AdditionalProperties : {} ``` -{{ Add description here }} +This examples returns all access packages. + +### Example 2: Get access package by Id -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' +Get-MgEntitlementManagementAccessPackage -AccessPackageId '5c17e2d4-b421-4c32-ac09-8b96cddd3042'| Format-List -{{ Add output here }} +AssignmentPolicies : +Catalog : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageCatalog1 +CreatedDateTime : 5/4/2022 10:02:17 AM +Description : +DisplayName : Marketing Campaign +Id : 5c17e2d4-b421-4c32-ac09-8b96cddd3042 +IsHidden : False +ModifiedDateTime : 5/4/2022 10:07:59 AM +AdditionalProperties : {[@odata.context, https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/accessPackages/$entity]} ``` -{{ Add description here }} - +This example returns the access package of the specified Id. diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md index 093355d11d5..12861d3deb9 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md @@ -1,6 +1,7 @@ -### Example 1: {{ Add title here }} +### Example 1: Get a list of all access package catalogs + ```powershell -PS C:\> {{ Add code here }} +Get-MgEntitlementManagementCatalog {{ Add output here }} ``` diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md index 093355d11d5..9be959d0846 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md @@ -1,18 +1,39 @@ -### Example 1: {{ Add title here }} +### Example 1: Get a list of all access package catalogs + ```powershell -PS C:\> {{ Add code here }} +Get-MgEntitlementManagementCatalog | fl -{{ Add output here }} +AccessPackages : +CatalogType : serviceDefault +CreatedDateTime : 1/13/2022 6:47:56 AM +Description : Built-in catalog. +DisplayName : General +Id : 88d3e491-5247-4209-9b56-c4c95d9694e9 +IsExternallyVisible : True +ModifiedDateTime : 1/13/2022 6:47:56 AM +State : published +AdditionalProperties : {} ``` -{{ Add description here }} +This examples gets a list of all the access package catalogs. + +### Example 2: Get a access package catalog by the AccessPackageCatalogId -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +Get-MgEntitlementManagementCatalog -AccessPackageCatalogId '88d3e491-5247-4209-9b56-c4c95d9694e9' |fl -{{ Add output here }} +AccessPackages : +CatalogType : serviceDefault +CreatedDateTime : 1/13/2022 6:47:56 AM +Description : Built-in catalog. +DisplayName : General +Id : 88d3e491-5247-4209-9b56-c4c95d9694e9 +IsExternallyVisible : True +ModifiedDateTime : 1/13/2022 6:47:56 AM +State : published +AdditionalProperties : {[@odata.context, https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManag + ement/catalogs/$entity]} ``` -{{ Add description here }} +his examples gets access package catalog for the specified access package Id. diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md index 093355d11d5..1c2f3dd9cb3 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md @@ -1,18 +1,11 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Get the identity governance settings -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +Get-MgEntitlementManagementSetting -{{ Add output here }} +Id ExternalUserLifecycleAction +-- --------------------------- +singleton blockSignInAndDelete ``` -{{ Add description here }} - +This example returns the identity governance settings. diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md index 093355d11d5..a371bb55094 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md @@ -1,18 +1,25 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Create an access package -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +$params = @{ +DisplayName = "Marketing Campaign" +Description = "Marketing Campaign" +IsHidden = $false +Catalog = @{ +Id = "88d3e491-5247-4209-9b56-c4c95d9694e9" +} + } +New-MgEntitlementManagementAccessPackage -BodyParameter $params -{{ Add output here }} +AssignmentPolicies : +Catalog : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageCatalog1 +CreatedDateTime : 9/15/2022 9:48:28 AM +Description : Marketing Campaign +DisplayName : Marketing Campaign +Id : fd6ec077-e933-418f-9b6f-df88a54f9eee +IsHidden : False +ModifiedDateTime : 9/15/2022 9:48:28 AM +AdditionalProperties : {[@odata.context, https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/accessPackages/$entity]} ``` -{{ Add description here }} - +This example creates an access package with he defined display name under the specified catalog. From 408d683d0fca2a2e279ebda4a7d31bb15ee0d948 Mon Sep 17 00:00:00 2001 From: Eunice Waweru <73849846+msewaweru@users.noreply.github.com> Date: Thu, 15 Sep 2022 17:49:10 +0300 Subject: [PATCH 2/3] Added more examples --- ...titlementManagementAccessPackageCatalog.md | 5 +- ...MgEntitlementManagementAssignmentPolicy.md | 65 +++++++++++++++---- .../Get-MgEntitlementManagementCatalog.md | 3 + .../Get-MgEntitlementManagementSetting.md | 2 + ...ew-MgEntitlementManagementAccessPackage.md | 2 + ...ve-MgEntitlementManagementAccessPackage.md | 15 +---- ...ManagementAccessPackageAssignmentPolicy.md | 17 ++--- 7 files changed, 70 insertions(+), 39 deletions(-) diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md index 12861d3deb9..8a0d69ba22c 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md @@ -1,13 +1,14 @@ ### Example 1: Get a list of all access package catalogs - ```powershell -Get-MgEntitlementManagementCatalog +PS C:\> {{ Add code here }} {{ Add output here }} ``` {{ Add description here }} + + ### Example 2: {{ Add title here }} ```powershell PS C:\> {{ Add code here }} diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAssignmentPolicy.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAssignmentPolicy.md index 093355d11d5..32fc792ede8 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAssignmentPolicy.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAssignmentPolicy.md @@ -1,18 +1,59 @@ -### Example 1: {{ Add title here }} +### Example 1: Create an access package assignment policy + ```powershell -PS C:\> {{ Add code here }} +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' -{{ Add output here }} -``` +$params = @{ + DisplayName = "New Policy" + Description = "policy for assignment" + AllowedTargetScope = "notSpecified" + SpecificAllowedTargets = @( + ) + Expiration = @{ + EndDateTime = $null + Duration = $null + Type = "noExpiration" + } + RequestorSettings = @{ + EnableTargetsToSelfAddAccess = $false + EnableTargetsToSelfUpdateAccess = $false + EnableTargetsToSelfRemoveAccess = $false + AllowCustomAssignmentSchedule = $true + EnableOnBehalfRequestorsToAddAccess = $false + EnableOnBehalfRequestorsToUpdateAccess = $false + EnableOnBehalfRequestorsToRemoveAccess = $false + OnBehalfRequestors = @( + ) + } + RequestApprovalSettings = @{ + IsApprovalRequiredForAdd = $false + IsApprovalRequiredForUpdate = $false + Stages = @( + ) + } + AccessPackage = @{ + Id = "a2e1ca1e-4e56-47d2-9daa-e2ba8d12a82b" + } +} -{{ Add description here }} +New-MgEntitlementManagementAssignmentPolicy -BodyParameter $params -### Example 2: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} +AccessPackage : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackage1 +AllowedTargetScope : notSpecified +AutomaticRequestSettings : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageAutomaticRequestSettings +Catalog : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageCatalog1 +CreatedDateTime : 9/15/2022 2:35:56 PM +Description : policy for assignment +DisplayName : New Policy +Expiration : Microsoft.Graph.PowerShell.Models.MicrosoftGraphExpirationPattern +Id : c39f299c-4f4b-4065-b3ea-5b607e867738 +ModifiedDateTime : 9/15/2022 2:35:56 PM +RequestApprovalSettings : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageAssignmentApprovalSettings +RequestorSettings : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageAssignmentRequestorSettings +ReviewSettings : Microsoft.Graph.PowerShell.Models.MicrosoftGraphAccessPackageAssignmentReviewSettings +SpecificAllowedTargets : {} +AdditionalProperties : {[@odata.context, + https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/assignmentPolicies/$entity]} ``` -{{ Add description here }} - +This example shows a request to create an access package assignment policy. diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md index 9be959d0846..e23b24a63c0 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementCatalog.md @@ -1,6 +1,8 @@ ### Example 1: Get a list of all access package catalogs ```powershell +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' + Get-MgEntitlementManagementCatalog | fl AccessPackages : @@ -20,6 +22,7 @@ This examples gets a list of all the access package catalogs. ### Example 2: Get a access package catalog by the AccessPackageCatalogId ```powershell +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' Get-MgEntitlementManagementCatalog -AccessPackageCatalogId '88d3e491-5247-4209-9b56-c4c95d9694e9' |fl AccessPackages : diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md index 1c2f3dd9cb3..1e703ad44b8 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementSetting.md @@ -1,6 +1,8 @@ ### Example 1: Get the identity governance settings ```powershell +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' + Get-MgEntitlementManagementSetting Id ExternalUserLifecycleAction diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md index a371bb55094..8ee86feacc1 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/New-MgEntitlementManagementAccessPackage.md @@ -1,6 +1,8 @@ ### Example 1: Create an access package ```powershell +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' + $params = @{ DisplayName = "Marketing Campaign" Description = "Marketing Campaign" diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackage.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackage.md index 093355d11d5..442fb041542 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackage.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackage.md @@ -1,18 +1,9 @@ ### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' -{{ Add output here }} +Remove-MgEntitlementManagementAccessPackage -AccessPackageId 'bc041fda-b3ba-41fc-b911-ca95f7aac656' ``` -{{ Add description here }} - +This example removes the specified access package. diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackageAssignmentPolicy.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackageAssignmentPolicy.md index 093355d11d5..487b2c061fe 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackageAssignmentPolicy.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Remove-MgEntitlementManagementAccessPackageAssignmentPolicy.md @@ -1,18 +1,9 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Remove an access package assignment policy -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +Connect-MgGraph -Scopes 'EntitlementManagement.ReadWrite.All' -{{ Add output here }} +Remove-MgEntitlementManagementAssignmentPolicy -AccessPackageAssignmentPolicyId '62073739-d160-40e4-8367-87e88d85d083' ``` -{{ Add description here }} - +This example removes the specified assignment policy. From 99141933729123672b1f55ccf072b0d5b111b581 Mon Sep 17 00:00:00 2001 From: Eunice Waweru <73849846+msewaweru@users.noreply.github.com> Date: Fri, 16 Sep 2022 14:04:18 +0300 Subject: [PATCH 3/3] minor edit --- .../v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md index 8a0d69ba22c..b92733edf7d 100644 --- a/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md +++ b/src/Identity.Governance/Identity.Governance/examples/v1.0/Get-MgEntitlementManagementAccessPackageCatalog.md @@ -1,4 +1,4 @@ -### Example 1: Get a list of all access package catalogs +### Example 1: {{ Add title here }} ```powershell PS C:\> {{ Add code here }}