你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Update-AzADGroup
更新组中的实体
语法
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>]
说明
更新组中的实体
示例
示例 1:组的更新说明
Update-AzADGroup -ObjectId $objectid -Description $description
更新组的说明。
参数
-AdditionalProperties
附加参数
类型: | Hashtable |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-AppRoleAssignment
表示已为应用程序授予组的应用角色。 支持$expand。 若要构造,请参阅 APPROLEASSIGNMENT 属性的 NOTES 部分并创建哈希表。
类型: | IMicrosoftGraphAppRoleAssignmentAutoGenerated[] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Classification
描述组的分类(如低、中或高业务影响)。 通过基于模板定义创建 ClassificationList 设置值来定义此属性的有效值。默认返回。 支持$filter(eq、ne、NOT、ge、le、startsWith)。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-CreatedOnBehalfOf
表示 Azure Active Directory 对象。 directoryObject 类型是许多其他目录实体类型的基类型。 若要构造,请参阅 CREATEDONBEHALFOF 属性的 NOTES 部分并创建哈希表。
类型: | IMicrosoftGraphDirectoryObject |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
类型: | PSObject |
别名: | AzureRMContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DeletedDateTime
。
类型: | DateTime |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Description
组的可选说明。 默认返回。 支持$filter(eq、ne、NOT、ge、le、startsWith)和$search。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DisplayName
目录中显示的名称
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-GroupType
指定组类型及其成员身份。 如果集合包含 Unified,则组为 Microsoft 365 组;否则,它是安全组或通讯组。 有关详细信息,请参阅组概述。如果集合包含 DynamicMembership,则组具有动态成员身份;否则,成员身份是静态的。 默认返回。 支持$filter(eq、NOT)。
类型: | String[] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-HasMembersWithLicenseError
指示此组中是否有成员在其基于组的许可证分配中出现许可证错误。 此属性永远不会在 GET 操作上返回。 可以使用它作为$filter参数来获取具有许可证错误的成员的组(即,筛选此属性为 true)。 支持$filter(eq)。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-IsArchived
。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-IsAssignableToRole
指示是否可以将此组分配到 Azure Active Directory 角色。只能在创建组时设置此属性,并且是不可变的。 如果设置为 true,则 securityEnabled 属性也必须设置为 true,并且该组不能是动态组(也就是说,groupTypes 不能包含 DynamicMembership)。 只有全局管理员和特权角色管理员角色中的调用方才能设置此属性。 还必须为调用方分配 Directory.AccessAsUser.All 权限才能设置此属性。 有关详细信息,请参阅默认使用组管理 Azure AD 角色分配。 支持$filter(eq、ne、NOT)。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-MailEnabled
指定组是否启用邮件。 默认返回。 支持$filter(eq、ne、NOT)。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-MailNickname
组的邮件别名,在组织中是唯一的。 创建组时必须指定此属性。 这些字符不能用于 mailNickName: @()/[];;:.<>,SPACE。 默认返回。 支持 $filter (eq, ne, NOT, ge, le, in, startsWith)。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-MembershipRule
如果组是动态组(groupTypes 包含 DynamicMembership),则确定此组的成员的规则。 有关成员资格规则语法的详细信息,请参阅成员资格规则语法。 默认返回。 支持$filter(eq、ne、NOT、ge、le、startsWith)。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-MembershipRuleProcessingState
指示动态成员身份处理是打开还是暂停。 可能的值为 On 或 Paused。 默认返回。 支持$filter(eq、ne、NOT、in)。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ObjectId
键:组 ID
类型: | String |
别名: | GroupId |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-PassThru
当命令成功时返回 true
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-PermissionGrant
已向特定应用程序授予组的权限。 支持$expand。 若要构造,请参阅 PERMISSIONGRANT 属性的 NOTES 部分并创建哈希表。
类型: | IMicrosoftGraphResourceSpecificPermissionGrant[] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-PreferredDataLocation
组的首选数据位置。 有关详细信息,请参阅 OneDrive Online 多地理位置。 默认返回。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-PreferredLanguage
Microsoft 365 组的首选语言。 应遵循 ISO 639-1 代码;例如“en-US”。 默认返回。 支持 $filter (eq, ne, NOT, ge, le, in, startsWith)。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-SecurityEnabled
指定组是否为安全组。 默认返回。 支持$filter(eq、ne、NOT、in)。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-SecurityIdentifier
在 Windows 方案中使用的组的安全标识符。 默认返回。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Theme
指定Microsoft 365 组的颜色主题。 可能的值为 Teal、紫色、绿色、蓝色、粉红色、橙色或红色。 默认返回。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Visibility
指定组的组策略和组内容可见性。 可能的值为:Private、Public 或 Hiddenmembership。 创建组时,只能为Microsoft 365 个组设置 Hiddenmembership。 以后无法更新它。 组创建后,可以更新其他可见性值。 如果在 Microsoft Graph 上的组创建期间未指定可见性值,则默认情况下会创建安全组,Microsoft 365 组为 Public。 有关详细信息,请参阅组可见性选项。 默认返回。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
输出
备注
别名
复杂参数属性
若要创建下面所述的参数,请构造一个包含相应属性的哈希表。 有关哈希表的信息,请运行 Get-Help about_Hash_Tables。
APPROLEASSIGNMENT <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>:表示已为应用程序授予组的应用角色。 支持$expand。
[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称[AppRoleId <String>]
:分配给主体的应用角色的标识符(ID)。 此应用角色必须在资源应用程序的服务主体 (resourceId) 的 appRoles 属性中公开。 如果资源应用程序未声明任何应用角色,则可以指定默认应用角色 ID 为 000000000-0000-0000-0000000000000,以指示主体已分配给资源应用,而无需任何特定应用角色。 创建时必需。[CreatedDateTime <DateTime?>]
:创建应用角色分配的时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。[PrincipalDisplayName <String>]
:授予应用角色分配的用户、组或服务主体的显示名称。 只读。 支持$filter(eq 和 startswith)。[PrincipalId <String>]
:授予应用角色的用户、组或服务主体的唯一标识符(ID)。 创建时必需。[PrincipalType <String>]
:分配的主体的类型。 这可以是 User、Group 或 ServicePrincipal。 只读。[ResourceDisplayName <String>]
:要向其分配的资源应用服务主体的显示名称。[ResourceId <String>]
:为其分配的资源服务主体的唯一标识符(ID)。 创建时必需。 支持$filter(仅限 eq)。
CREATEDONBEHALFOF <IMicrosoftGraphDirectoryObject>
:表示 Azure Active Directory 对象。 directoryObject 类型是许多其他目录实体类型的基类型。
[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称
PERMISSIONGRANT <IMicrosoftGraphResourceSpecificPermissionGrant[]>:已向特定应用程序授予组的权限。 支持$expand。
[DeletedDateTime <DateTime?>]
:[DisplayName <String>]
:目录中显示的名称[ClientAppId <String>]
:已授予访问权限的 Azure AD 应用的服务主体的 ID。 只读。[ClientId <String>]
:已授予访问权限的 Azure AD 应用的 ID。 只读。[Permission <String>]
:特定于资源的权限的名称。 只读。[PermissionType <String>]
:权限的类型。 可能的值包括:应用程序、委派值。 只读。[ResourceAppId <String>]
:托管资源的 Azure AD 应用的 ID。 只读。