Skip to content

Latest commit

 

History

History
455 lines (370 loc) · 15.2 KB

Update-MgDirectoryAdministrativeUnit.md

File metadata and controls

455 lines (370 loc) · 15.2 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Identity.DirectoryManagement-help.xml
Microsoft.Graph.Identity.DirectoryManagement
2.0.0

Update-MgDirectoryAdministrativeUnit

SYNOPSIS

Update the properties of an administrativeUnit object.

Note

To view the beta release of this cmdlet, view Update-MgBetaDirectoryAdministrativeUnit

SYNTAX

UpdateExpanded (Default)

Update-MgDirectoryAdministrativeUnit -AdministrativeUnitId <String> [-ResponseHeadersVariable <String>]
 [-AdditionalProperties <Hashtable>] [-DeletedDateTime <DateTime>] [-Description <String>]
 [-DisplayName <String>] [-Extensions <IMicrosoftGraphExtension[]>] [-Id <String>]
 [-Members <IMicrosoftGraphDirectoryObject[]>] [-ScopedRoleMembers <IMicrosoftGraphScopedRoleMembership[]>]
 [-Visibility <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Update

Update-MgDirectoryAdministrativeUnit -AdministrativeUnitId <String>
 -BodyParameter <IMicrosoftGraphAdministrativeUnit> [-ResponseHeadersVariable <String>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgDirectoryAdministrativeUnit -InputObject <IIdentityDirectoryManagementIdentity>
 [-ResponseHeadersVariable <String>] [-AdditionalProperties <Hashtable>] [-DeletedDateTime <DateTime>]
 [-Description <String>] [-DisplayName <String>] [-Extensions <IMicrosoftGraphExtension[]>] [-Id <String>]
 [-Members <IMicrosoftGraphDirectoryObject[]>] [-ScopedRoleMembers <IMicrosoftGraphScopedRoleMembership[]>]
 [-Visibility <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

UpdateViaIdentity

Update-MgDirectoryAdministrativeUnit -InputObject <IIdentityDirectoryManagementIdentity>
 -BodyParameter <IMicrosoftGraphAdministrativeUnit> [-ResponseHeadersVariable <String>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update the properties of an administrativeUnit object.

EXAMPLES

Example 1: Code snippet

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	displayName = "Greater Seattle District Technical Schools"
}

Update-MgDirectoryAdministrativeUnit -AdministrativeUnitId $administrativeUnitId -BodyParameter $params

This example shows how to use the Update-MgDirectoryAdministrativeUnit Cmdlet.

PARAMETERS

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdministrativeUnitId

The unique identifier of administrativeUnit

Type: String
Parameter Sets: UpdateExpanded, Update
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BodyParameter

administrativeUnit To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type: IMicrosoftGraphAdministrativeUnit
Parameter Sets: Update, UpdateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DeletedDateTime

Date and time when this object was deleted. Always null when the object hasn't been deleted.

Type: DateTime
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisplayName

Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Extensions

The collection of open extensions defined for this administrative unit. Nullable. To construct, see NOTES section for EXTENSIONS properties and create a hash table.

Type: IMicrosoftGraphExtension[]
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Id

The unique identifier for an entity. Read-only.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Members

Users and groups that are members of this administrative unit. Supports $expand. To construct, see NOTES section for MEMBERS properties and create a hash table.

Type: IMicrosoftGraphDirectoryObject[]
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ScopedRoleMembers

Scoped-role members of this administrative unit. To construct, see NOTES section for SCOPEDROLEMEMBERS properties and create a hash table.

Type: IMicrosoftGraphScopedRoleMembership[]
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Visibility

Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit

System.Collections.IDictionary

OUTPUTS

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit

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 <IMicrosoftGraphAdministrativeUnit>: administrativeUnit

  • [(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>]: An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.
  • [DisplayName <String>]: Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
  • [Extensions <IMicrosoftGraphExtension- []>]: The collection of open extensions defined for this administrative unit. Nullable.
    • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Members <IMicrosoftGraphDirectoryObject- []>]: Users and groups that are members of this administrative unit. 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.
  • [ScopedRoleMembers <IMicrosoftGraphScopedRoleMembership- []>]: Scoped-role members of this administrative unit.
    • [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. 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 won't show up as having changed when using delta.
      • [Id <String>]: Unique identifier for the identity.
  • [Visibility <String>]: Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.

EXTENSIONS <IMicrosoftGraphExtension- []>: The collection of open extensions defined for this administrative unit. Nullable.

  • [Id <String>]: The unique identifier for an entity. Read-only.

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
  • [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 and groups that are members of this administrative unit. 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.

SCOPEDROLEMEMBERS <IMicrosoftGraphScopedRoleMembership- []>: Scoped-role members of this administrative unit.

  • [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. 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 won't show up as having changed when using delta.
    • [Id <String>]: Unique identifier for the identity.

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/update-mgdirectoryadministrativeunit

https://learn.microsoft.com/graph/api/administrativeunit-update?view=graph-rest-1.0