Update-MgDirectoryRoleByRoleTemplateId
Update entity in directoryRoles by roleTemplateId
Note
To view the beta release of this cmdlet, view Update-MgBetaDirectoryRoleByRoleTemplateId
Syntax
Update-MgDirectoryRoleByRoleTemplateId
-RoleTemplateId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-DeletedDateTime <DateTime>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-Members <IMicrosoftGraphDirectoryObject[]>]
[-RoleTemplateId1 <String>]
[-ScopedMembers <IMicrosoftGraphScopedRoleMembership[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgDirectoryRoleByRoleTemplateId
[-RoleTemplateId <String>]
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-DeletedDateTime <DateTime>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-Members <IMicrosoftGraphDirectoryObject[]>]
[-ScopedMembers <IMicrosoftGraphScopedRoleMembership[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgDirectoryRoleByRoleTemplateId
-RoleTemplateId <String>
-BodyParameter <IMicrosoftGraphDirectoryRole>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgDirectoryRoleByRoleTemplateId
-InputObject <IIdentityDirectoryManagementIdentity>
-BodyParameter <IMicrosoftGraphDirectoryRole>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update entity in directoryRoles by roleTemplateId
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
directoryRole To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphDirectoryRole |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeletedDateTime
Date and time when this object was deleted. Always null when the object hasn't been deleted.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
The description for the directory role. Read-only. Supports $filter (eq), $search, $select.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
The display name for the directory role. Read-only. Supports $filter (eq), $search, $select.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IIdentityDirectoryManagementIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Members
Users that are members of this directory role. HTTP Methods: GET, POST, DELETE. Read-only. Nullable. Supports $expand. To construct, see NOTES section for MEMBERS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RoleTemplateId
Alternate key of directoryRole
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RoleTemplateId1
The id of the directoryRoleTemplate that this role is based on. The property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read only. Supports $filter (eq), $select.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScopedMembers
Members of this directory role that are scoped to administrative units. Read-only. Nullable. To construct, see NOTES section for SCOPEDMEMBERS properties and create a hash table.
Type: | IMicrosoftGraphScopedRoleMembership[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryRole
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryRole
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IMicrosoftGraphDirectoryRole>
: directoryRole
[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: The description for the directory role. Read-only. Supports $filter (eq), $search, $select.[DisplayName <String>]
: The display name for the directory role. Read-only. Supports $filter (eq), $search, $select.[Members <IMicrosoftGraphDirectoryObject-
[]>]
: Users that are members of this directory role. HTTP Methods: GET, POST, DELETE. Read-only. Nullable. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[RoleTemplateId <String>]
: The id of the directoryRoleTemplate that this role is based on. The property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read only. Supports $filter (eq), $select.[ScopedMembers <IMicrosoftGraphScopedRoleMembership-
[]>]
: Members of this directory role that are scoped to administrative units. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AdministrativeUnitId <String>]
: Unique identifier for the administrative unit that the directory role is scoped to[RoleId <String>]
: Unique identifier for the directory role that the member is in.[RoleMemberInfo <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>
: Identity Parameter
[AdministrativeUnitId <String>]
: The unique identifier of administrativeUnit[AllowedValueId <String>]
: The unique identifier of allowedValue[AttributeSetId <String>]
: The unique identifier of attributeSet[CommerceSubscriptionId <String>]
: Alternate key of companySubscription[CompanySubscriptionId <String>]
: The unique identifier of companySubscription[ContractId <String>]
: The unique identifier of contract[CustomSecurityAttributeDefinitionId <String>]
: The unique identifier of customSecurityAttributeDefinition[DeviceId <String>]
: The unique identifier of device[DeviceLocalCredentialInfoId <String>]
: The unique identifier of deviceLocalCredentialInfo[DirectoryObjectId <String>]
: The unique identifier of directoryObject[DirectoryRoleId <String>]
: The unique identifier of directoryRole[DirectoryRoleTemplateId <String>]
: The unique identifier of directoryRoleTemplate[DomainDnsRecordId <String>]
: The unique identifier of domainDnsRecord[DomainId <String>]
: The unique identifier of domain[ExtensionId <String>]
: The unique identifier of extension[IdentityProviderBaseId <String>]
: The unique identifier of identityProviderBase[InternalDomainFederationId <String>]
: The unique identifier of internalDomainFederation[OnPremisesDirectorySynchronizationId <String>]
: The unique identifier of onPremisesDirectorySynchronization[OrgContactId <String>]
: The unique identifier of orgContact[OrganizationId <String>]
: The unique identifier of organization[OrganizationalBrandingLocalizationId <String>]
: The unique identifier of organizationalBrandingLocalization[ProfileCardPropertyId <String>]
: The unique identifier of profileCardProperty[RoleTemplateId <String>]
: Alternate key of directoryRole[ScopedRoleMembershipId <String>]
: The unique identifier of scopedRoleMembership[SubscribedSkuId <String>]
: The unique identifier of subscribedSku[UserId <String>]
: The unique identifier of user
MEMBERS <IMicrosoftGraphDirectoryObject- []
>: Users that are members of this directory role.
HTTP Methods: GET, POST, DELETE.
Read-only.
Nullable.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
SCOPEDMEMBERS <IMicrosoftGraphScopedRoleMembership- []
>: Members of this directory role that are scoped to administrative units.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[AdministrativeUnitId <String>]
: Unique identifier for the administrative unit that the directory role is scoped to[RoleId <String>]
: Unique identifier for the directory role that the member is in.[RoleMemberInfo <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.