Set-EntraUserExtension

Módulo:
Microsoft.Entra.Users Module v1.3

Atualiza a extensão de um usuário.

Sintaxe

SetSingle (Default) 

Set-EntraUserExtension

    -UserId <String>
    -ExtensionName <String>
    -ExtensionValue <String>
    [<CommonParameters>]

SetMultiple 

Set-EntraUserExtension

    -UserId <String>
    -ExtensionNameValues <System.Collections.Generic.Dictionary`2[System.String,System.String]>
    [<CommonParameters>]

Description

O Set-EntraUserExtension cmdlet atualiza a extensão de um usuário em Microsoft Entra ID.

Update-EntraUserExtension é um alias para Set-EntraUserExtension.

Exemplos

Exemplo 1: Definir o valor de um atributo de extensão para um usuário

Connect-Entra -Scopes 'User.ReadWrite.All'
$extensionName = 'extension_e5e29b8a85d941eab8d12162bd004528_JobGroup'
$extensionValue = 'Job Group D'
Set-EntraUserExtension -UserId 'SawyerM@contoso.com' -ExtensionName $extensionName -ExtensionValue $extensionValue

Este exemplo demonstra como atualizar o atributo de extensão de um usuário para um usuário especificado. Use (Get-EntraApplicationExtensionProperty -ApplicationId '{ApplicationId}').Name | Select-Object -First 1 para recuperar o nome da extensão.

  • -UserId o parâmetro especifica a ID do usuário (Nome de Entidade de Usuário ou UserId).
  • -ExtensionName o parâmetro especifica o nome de uma extensão.
  • -ExtensionValue o parâmetro especifica os valores do nome da extensão.

Exemplo 2: atualizar vários valores usando o parâmetro ExtensionNameValues

Connect-Entra -Scopes 'User.ReadWrite.All'
$userExtensionValues = New-Object 'System.Collections.Generic.Dictionary[String,String]'
$userExtensionValues.Add("extension_d2ba83696c3f45429fbabb363ae391a0_Benefits", "Pension")
$userExtensionValues.Add("extension_d2ba83696c3f45429fbabb363ae391a0_JobGroup", "D")
Set-EntraUserExtension -UserId 'SawyerM@contoso.com' -ExtensionNameValues $userExtensionValues

Este exemplo demonstra como atualizar o atributo de extensão de um usuário. Use (Get-EntraApplicationExtensionProperty -ApplicationId '{ApplicationId}').Name | Select-Object -First 1 para recuperar o nome da extensão.

  • -UserId o parâmetro especifica a ID do usuário (Nome de Entidade de Usuário ou UserId).
  • -ExtensionNameValues o parâmetro especifica um dicionário de pares chave-valor para o nome da extensão e o par de valor.

Parâmetros

-ExtensionName

Especifica o nome de uma extensão.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetSingle
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ExtensionNameValues

Especifica valores de nome de extensão.

Propriedades do parâmetro

Tipo:

System.Collections.Generic.Dictionary`2[System.String,System.String]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetMultiple
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ExtensionValue

Especifica um valor de extensão.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetSingle
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-UserId

Especifica o identificador exclusivo para o usuário (Nome de Entidade de Usuário ou UserId).

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:IdentificadorDeObjeto, UPN, Identidade, Nome Principal do Usuário

Conjuntos de parâmetros

SetSingle
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
SetMultiple
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Observações

Update-EntraUserExtension é um alias para Set-EntraUserExtension.