Update-AzADGroup
Syntax
UpdateExpanded (Default)
Update-AzADGroup
-ObjectId <String>
[-AdditionalProperties <Hashtable>]
[-AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]
[-Classification <String>]
[-CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]
[-DeletedDateTime <DateTime>]
[-Description <String>]
[-DisplayName <String>]
[-GroupType <String[]>]
[-HasMembersWithLicenseError]
[-IsArchived]
[-IsAssignableToRole]
[-MailEnabled]
[-MailNickname <String>]
[-MembershipRule <String>]
[-MembershipRuleProcessingState <String>]
[-PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]
[-PreferredDataLocation <String>]
[-PreferredLanguage <String>]
[-SecurityEnabled]
[-SecurityIdentifier <String>]
[-Theme <String>]
[-Visibility <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzADGroup
-ObjectId <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzADGroup
-ObjectId <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1: Update description for group
Update-AzADGroup -ObjectId $objectid -Description $description
Update description for group.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AppRoleAssignment
Represents the app roles a group has been granted for an application.
Supports $expand.
Parameter properties
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Classification
Describes a classification for the group (such as low, medium or high business impact).
Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default.
Supports $filter (eq, ne, NOT, ge, le, startsWith).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CreatedOnBehalfOf
Represents an Azure Active Directory object.
The directoryObject type is the base type for many other directory entity types.
Parameter properties
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DeletedDateTime
.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Description
An optional description for the group.
Returned by default.
Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayName
The name displayed in directory
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GroupType
Specifies the group type and its membership.
If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group.
For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static.
Returned by default.
Supports $filter (eq, NOT).
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-HasMembersWithLicenseError
Indicates whether there are members in this group that have license errors from its group-based license assignment.
This property is never returned on a GET operation.
You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true).
Supports $filter (eq).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IsArchived
.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IsAssignableToRole
Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable.
If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership).
Only callers in Global administrator and Privileged role administrator roles can set this property.
The caller must also be assigned the Directory.AccessAsUser.All permission to set this property.
For more, see Using a group to manage Azure AD role assignmentsReturned by default.
Supports $filter (eq, ne, NOT).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MailEnabled
Specifies whether the group is mail-enabled.
Returned by default.
Supports $filter (eq, ne, NOT).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MailNickname
The mail alias for the group, unique in the organization.
This property must be specified when a group is created.
These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE.
Returned by default.
Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MembershipRule
The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership).
For more information about the syntax of the membership rule, see Membership Rules syntax.
Returned by default.
Supports $filter (eq, ne, NOT, ge, le, startsWith).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MembershipRuleProcessingState
Indicates whether the dynamic membership processing is on or paused.
Possible values are On or Paused.
Returned by default.
Supports $filter (eq, ne, NOT, in).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ObjectId
key: id of group
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: GroupId
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Returns true when the command succeeds
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PermissionGrant
The permissions that have been granted for a group to a specific application.
Supports $expand.
Parameter properties
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PreferredDataLocation
The preferred data ___location for the group.
For more information, see OneDrive Online Multi-Geo.
Returned by default.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PreferredLanguage
The preferred language for a Microsoft 365 group.
Should follow ISO 639-1 Code; for example 'en-US'.
Returned by default.
Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SecurityEnabled
Specifies whether the group is a security group.
Returned by default.
Supports $filter (eq, ne, NOT, in).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SecurityIdentifier
Security identifier of the group, used in Windows scenarios.
Returned by default.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Theme
Specifies a Microsoft 365 group's color theme.
Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red.
Returned by default.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Visibility
Specifies the group join policy and group content visibility for groups.
Possible values are: Private, Public, or Hiddenmembership.
Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created.
It can't be updated later.
Other values of visibility can be updated after group creation.
If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public.
See group visibility options to learn more.
Returned by default.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
