Update-MgBetaDirectorySetting

Module:

Microsoft.Graph.Beta.Identity.DirectoryManagement

Update the properties of a specific directory setting object.

Syntax

Update-MgBetaDirectorySetting
      -DirectorySettingId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-DisplayName <String>]
      [-Id <String>]
      [-TemplateId <String>]
      [-Values <IMicrosoftGraphSettingValue[]>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaDirectorySetting
      -DirectorySettingId <String>
      -BodyParameter <IMicrosoftGraphDirectorySetting>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaDirectorySetting
      -InputObject <IIdentityDirectoryManagementIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-DisplayName <String>]
      [-Id <String>]
      [-TemplateId <String>]
      [-Values <IMicrosoftGraphSettingValue[]>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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

Description

Update the properties of a specific directory setting object.

Examples

Example 1: Using the Update-MgBetaDirectorySetting Cmdlet

Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
	Values = @(
		@{
			Name = "CustomBlockedWordsList"
			Value = "Contoso"
		}
	)
}
Update-MgBetaDirectorySetting -DirectorySettingId $directorySettingId -BodyParameter $params

This example shows how to use the Update-MgBetaDirectorySetting Cmdlet. To learn about permissions for this resource, see the permissions reference.

Parameters

-AdditionalProperties

Additional Parameters

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

-BodyParameter

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

Type:	IMicrosoftGraphDirectorySetting
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

-DirectorySettingId

The unique identifier of directorySetting

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

-DisplayName

Display name of this group of settings, which comes from the associated template. Read-only.

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

-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

-TemplateId

Unique identifier for the template used to create this group of settings. Read-only.

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

-Values

Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object. To construct, see NOTES section for VALUES properties and create a hash table.

Type:	IMicrosoftGraphSettingValue[]
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.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDirectorySetting

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDirectorySetting

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 <IMicrosoftGraphDirectorySetting>: directorySetting

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [DisplayName <String>]: Display name of this group of settings, which comes from the associated template. Read-only.
• [TemplateId <String>]: Unique identifier for the template used to create this group of settings. Read-only.
• [Values <IMicrosoftGraphSettingValue- []>]: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.
  • [Name <String>]: Name of the setting (as defined by the directorySettingTemplate).
  • [Value <String>]: Value of the setting.

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
• [CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity
• [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration
• [CommandId <String>]: The unique identifier of command
• [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
• [DirectorySettingId <String>]: The unique identifier of directorySetting
• [DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate
• [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
• [DomainId <String>]: The unique identifier of domain
• [ExtensionId <String>]: The unique identifier of extension
• [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile
• [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy
• [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
• [ImpactedResourceId <String>]: The unique identifier of impactedResource
• [InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile
• [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
• [ManagedTenantAlertId <String>]: The unique identifier of managedTenantAlert
• [ManagementActionId <String>]: The unique identifier of managementAction
• [OcpSubscriptionId <String>]: Alternate key of companySubscription
• [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
• [OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile
• [PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile
• [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
• [RecommendationId <String>]: The unique identifier of recommendation
• [RoleTemplateId <String>]: Alternate key of directoryRole
• [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
• [SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain
• [SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation
• [SubscribedSkuId <String>]: The unique identifier of subscribedSku
• [TenantId <String>]: The unique identifier of tenant
• [TenantReferenceTenantId <String>]: The unique identifier of tenantReference
• [TenantTagId <String>]: The unique identifier of tenantTag
• [UsageRightId <String>]: The unique identifier of usageRight
• [UserId <String>]: The unique identifier of user

VALUES <IMicrosoftGraphSettingValue- []>: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.

• [Name <String>]: Name of the setting (as defined by the directorySettingTemplate).
• [Value <String>]: Value of the setting.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.directorymanagement/update-mgbetadirectorysetting
• https://learn.microsoft.com/graph/api/directorysetting-update?view=graph-rest-1.0