{"id":51,"date":"2025-12-01T18:00:52","date_gmt":"2025-12-02T02:00:52","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/entrapowershell\/?p=51"},"modified":"2025-12-01T22:43:14","modified_gmt":"2025-12-02T06:43:14","slug":"appendselected-parameter","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/entrapowershell\/appendselected-parameter\/","title":{"rendered":"AppendSelected parameter"},"content":{"rendered":"

Background<\/span>\u00a0<\/span><\/h2>\n

The\u202f <\/span>Property<\/span><\/b>\u202fparameter introduced in Version\u202f<\/span>0.10.0-preview<\/span><\/b><\/a> allowed customers to select specific properties they would want to return in the response and is used in these 2 main scenarios:<\/span>\u202f<\/span>\u00a0<\/span><\/p>\n

    \n
  1. To request extra properties that are not returned by default.\u202f<\/span>\u202f<\/span>\u00a0<\/span><\/li>\n
  2. To return a subset of the properties when the response returns\u202fa lot\u202fof properties by default\u202f(for performance reasons).<\/span>\u202f<\/span>\u00a0<\/span><\/li>\n<\/ol>\n

    The scenarios above introduce a limitation where only the\u202fspecified properties are\u202freturned,\u202fwhile the default properties are excluded from the response.<\/span>\u202f<\/span>\u00a0<\/span><\/p>\n

    The<\/span> AppendSelected<\/span><\/b>\u202fswitch\u202fparameter we shipped in version <\/span>1.0.12<\/span><\/b><\/a> solves this limitation by ensuring that the default properties are returned together with the specified properties.<\/span>\u202f<\/span>\u00a0<\/span><\/p>\n

    Implementation<\/span>\u00a0<\/span><\/h2>\n

    This parameter has been implemented in some Get-* cmdlets in the <\/span>Microsoft.Entra.Users<\/span><\/a>, <\/span>Microsoft.Entra.Groups<\/span><\/a> and <\/span>Microsoft.Entra.Applications<\/span><\/a> sub-modules.<\/span>\u00a0<\/span><\/p>\n

    Usage<\/span>\u00a0<\/span><\/h2>\n

    Install Entra PowerShell<\/span><\/code><\/h3>\n
    Install-Module -Name Microsoft.Entra -RequiredVersion 1.0.12 -Repository PSGallery -Force -AllowClobber<\/span>\u00a0<\/span><\/pre>\n
    Note we are installing the version which we shipped this feature. All later versions should contain this feature.\u00a0<\/span><\/p>\n
    Connect to the tenant<\/span>\u00a0<\/span><\/h3>\n
    We use the <\/span>Connect-Entra<\/span><\/a> cmdlet to connect to a Microsoft tenant. You pass all the required scopes.<\/span>\u00a0<\/span><\/p>\n
    We can start by invoking the command without the AppendSelected<\/strong> parameter.<\/p>\n
    Get-EntraGroup -GroupId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Property IsManagementRestricted | Select-Object Id, DisplayName, MailEnabled, Visibility, IsManagementRestricted | Format-Table -AutoSize<\/code><\/pre>\n
    Below is the output<\/p>\n
    Id \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f DisplayName \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202fMailEnabled     Visibility IsManagementRestricted \r\n\r\n-- \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f ----------- \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f--------------- ----------  ----------             \r\n\r\n  \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f  \u202f \u202f                                                              False                  <\/code><\/pre>\n
    Since in our property selection we only selected IsManagementRestricted<\/strong>, some important properties are blank.<\/p>\n
    Let’s now invoke the command with the AppendSelected<\/strong> parameter.<\/span><\/p>\n
    Get-EntraGroup -GroupId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Property IsManagementRestricted -AppendSelected | Select-Object Id, DisplayName, MailEnabled, Visibility, IsSubscribedByMail | Format-Table -AutoSize <\/code><\/pre>\n
    Output<\/span><\/p>\n
    Id \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f DisplayName \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202fMailEnabled     Visibility IsManagementRestricted \r\n\r\n-- \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f ----------- \u202f \u202f \u202f \u202f \u202f \u202f \u202f \u202f--------------- ---------- ----------\u00a0            \r\n\r\naaaaaaaa-0000-1111-2222-bbbbbbbbbbbb SimpleGroup \u202f \u202f \u202f \u202f \u202f \u202f \u202f  False \u202f \u202f \u202f \u202f \u202f  Public \u202f \u202f False                 <\/code><\/pre>\n
    This example demonstrates how to append a selected property to the default properties.<\/span>\u00a0<\/span> We have selected IsManagementRestricted<\/code> property. Id, DisplayName, MailEnabled, Visibility are also returned.<\/span><\/p>\n
    Summary<\/span>\u00a0<\/span><\/h2>\n
    This post demonstrates how we can use the\u00a0 AppendSelected<\/strong> parameter. This parameter is only available in a few Get-* cmdlets. With time, we will add the parameter to more cmdlets.<\/span>\u00a0<\/span><\/p>\n
    Kindly do not hesitate to leave your comments below or <\/span>create github issues<\/span><\/a> whenever you encounter an issue or you would like us to add the parameter to specific cmdlet(s).<\/span>\u00a0<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
    Background\u00a0 The\u202f Property\u202fparameter introduced in Version\u202f0.10.0-preview allowed customers to select specific properties they would want to return in the response and is used in these 2 main scenarios:\u202f\u00a0 To request extra properties that are not returned by default.\u202f\u202f\u00a0 To return a subset of the properties when the response returns\u202fa lot\u202fof properties by default\u202f(for performance reasons).\u202f\u00a0 […]<\/p>\n","protected":false},"author":20598,"featured_media":10,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-51","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-entra-powershell"],"acf":[],"blog_post_summary":"
    Background\u00a0 The\u202f Property\u202fparameter introduced in Version\u202f0.10.0-preview allowed customers to select specific properties they would want to return in the response and is used in these 2 main scenarios:\u202f\u00a0 To request extra properties that are not returned by default.\u202f\u202f\u00a0 To return a subset of the properties when the response returns\u202fa lot\u202fof properties by default\u202f(for performance reasons).\u202f\u00a0 […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/posts\/51","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/users\/20598"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/comments?post=51"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/posts\/51\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/media\/10"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/media?parent=51"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/categories?post=51"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/entrapowershell\/wp-json\/wp\/v2\/tags?post=51"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}