Set-EntraUser

ユーザーを更新します。

構文

Default (既定)

Set-EntraUser

    -UserId <String>
    [-PostalCode <String>]
    [-CompanyName <String>]
    [-GivenName <String>]
    [-Mobile <String>]
    [-PreferredLanguage <String>]
    [-CreationType <String>]
    [-UsageLocation <String>]
    [-UserType <String>]
    [-AgeGroup <String>]
    [-MailNickName <String>]
    [-ExtensionProperty <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
    [-ConsentProvidedForMinor <String>]
    [-ImmutableId <String>]
    [-Country <String>]
    [-SignInNames <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]>]
    [-Department <String>]
    [-StreetAddress <String>]
    [-PasswordPolicies <String>]
    [-JobTitle <String>]
    [-City <String>]
    [-OtherMails <System.Collections.Generic.List`1[System.String]>]
    [-UserPrincipalName <String>]
    [-DisplayName <String>]
    [-AccountEnabled <Boolean>]
    [-PasswordProfile <PasswordProfile>]
    [-State <String>]
    [-TelephoneNumber <String>]
    [-Surname <String>]
    [-ShowInAddressList <Boolean>]
    [<CommonParameters>]

説明

Set-EntraUser コマンドレットは、Microsoft Entra IDのユーザーを更新します。 Microsoft Entra IDでユーザーを更新するUserId パラメーターを指定します。

Update-EntraUserSet-EntraUser の別名です。

例 1: ユーザーを更新する

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -DisplayName 'Updated user Name'

次の使用例は、指定したユーザーの表示名パラメーターを更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。

例 2: 指定したユーザーの AccountEnabled パラメーターを設定する

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AccountEnabled $true

次の使用例は、指定したユーザーの AccountEnabled パラメーターを更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。
  • -AccountEnabled アカウントが有効かどうかを指定します。

例 3: 保護者の同意を得て、指定されたすべてのユーザーを未成年者として設定する

Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUser -All | Where-Object -Property DisplayName -Match '(George|James|Education)' |
ForEach-Object { Set-EntraUser -UserId $($_.Id) -AgeGroup 'minor' -ConsentProvidedForMinor 'granted' }

次の使用例は、保護者の同意を得て、指定されたユーザーを未成年者として更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。
  • -ConsentProvidedForMinor 未成年者に対して同意を得る必要があるかどうかを設定します。 許可される値: null、許可、拒否、および notRequired。

例 4: 指定したユーザーのプロパティを設定する

Connect-Entra -Scopes 'User.ReadWrite.All'
$params = @{
    UserId           = 'SawyerM@contoso.com'
    City             = 'Add city name'
    CompanyName      = 'Microsoft'
    Country          = 'Add country name'
    Department       = 'Add department name'
    GivenName        = 'Sawyer Miller G'
    JobTitle         = 'Manager'
    MailNickName     = 'Add mailnickname'
    Mobile           = '9984534564'
    OtherMails       = 'johndoe@contosodev.com'
    PasswordPolicies = 'DisableStrongPassword'
    State            = 'UP'
    StreetAddress    = 'Add address'
    UserType         = 'Member'
}
Set-EntraUser @params

次の使用例は、指定したユーザーのプロパティを更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。
  • -UserType "Member" や "Guest" など、ディレクトリ内のユーザーの種類を分類します。
  • -PasswordPolicies ユーザーのパスワード ポリシーを指定します。
  • -OtherMails ユーザーのその他の電子メール アドレスを指定します

例 5: 指定したユーザーの PasswordProfile パラメーターを設定する

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -PasswordProfile @{
    Password = '*****'
    ForceChangePasswordNextSignIn = $true
}

次の使用例は、指定したユーザーの PasswordProfile パラメーターを更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。
  • -PasswordProfile は、ユーザーのパスワード プロファイルを指定します。

例 6: ライセンス割り当てのユーザーの使用場所を設定する

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -UsageLocation 'US'

次の使用例は、指定したユーザーのライセンス管理の使用場所を更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。
  • -UsageLocation は、ユーザーの使用場所を指定します。 2 文字の ISO 3166 国コード。 ライセンスを持つユーザーがサービスの可用性を確認するために必要です。 例: US、JP、GB。 NULL 値は許可されません。

例 7: ユーザーのパスワード ポリシーを更新する

Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUser -UserId 'SawyerM@contoso.com' | Set-EntraUser -PasswordPolicies DisablePasswordExpiration

次の使用例は、指定したユーザーのパスワード ポリシーを更新します。

パスワード ポリシーに使用できる値は次のとおりです。

  • DisableStrongPassword: 既定のポリシーよりも脆弱なパスワードを許可します。
  • DisablePasswordExpiration: パスワードの有効期限が切れないようにします。

DisablePasswordExpirationDisableStrongPasswordなど、両方の値を一緒に指定できます。 たとえば、「 Set-EntraUser -UserId 'SawyerM@contoso.com' -PasswordPolicies "DisablePasswordExpiration,DisableStrongPassword" 」のように入力します。

例 8: ユーザーの拡張機能のプロパティを設定する

Connect-Entra -Scopes 'User.ReadWrite.All'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$extensionName = (Get-EntraApplicationExtensionProperty -ApplicationId $application.Id).Name | Select-Object -First 1
$additionalProperties = @{ $extensionName = "Survey.Report" }
Set-EntraUser -UserId 'SawyerM@contoso.com' -AdditionalProperties $additionalProperties

次の使用例は、指定したユーザーの拡張機能プロパティ (アプリケーションのアプリ ロールなど) を更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。

例 9: ユーザーの onPremisesExtension 属性のプロパティを更新する

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AdditionalProperties @{
    onPremisesExtensionAttributes = @{
        extensionAttribute1 = "Job Group D"
        extensionAttribute2 = "Audit Role"
    }
}

次の使用例は、指定したユーザーの onPremisesExtensionAttributes プロパティを更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。

例 10: ユーザーの電話の詳細を更新する

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -BusinessPhones '+1 425 555 0109' -OfficeLocation '18/2111'

次の使用例は、指定したユーザーの onPremisesExtensionAttributes プロパティを更新します。

  • -UserId ユーザー プリンシパル名 (UPN) または UserId として ID を指定します。

パラメーター

-AccountEnabled

アカウントが有効かどうかを示します。

パラメーターのプロパティ

型:System.Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AgeGroup

エンタープライズ アプリケーションで使用され、ユーザーの法的年齢グループを示します。 このプロパティは読み取り専用で、ageGroup と consentProvidedForMinor プロパティに基づいて計算されます。 使用できる値: null、minor、notAdult、および adult。 法的年齢グループを参照してください。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-City

ユーザーの市区町村を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-CompanyName

ユーザーが関連付けられている会社名。 このプロパティは、外部ユーザーが所属する会社を記述するのに役立ちます。 会社名の最大長は 64 文字です。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ConsentProvidedForMinor

未成年者に対して同意を得る必要があるかどうかを設定します。 許可される値: null、許可、拒否、および notRequired。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Country

ユーザーの国を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-CreationType

ユーザー アカウントが Microsoft Entra ID B2C テナントのローカル アカウントであるかどうかを示します。 指定できる値は "LocalAccount" と null です。 ローカル アカウントを作成するときは、プロパティが必要であり、"LocalAccount" に設定する必要があります。 職場または学校アカウントを作成するときは、プロパティを指定したり、null に設定したりしないでください。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Department

ユーザーの部署を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DisplayName

ユーザーの表示名を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ExtensionProperty

基本的なオープン拡張機能またはより汎用性の高いスキーマ拡張機能として、カスタム ユーザー プロパティにデータを追加します。

パラメーターのプロパティ

型:

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

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-GivenName

ユーザーの指定した名前を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ImmutableId

このプロパティは、オンプレミスの Active Directoryユーザー アカウントをMicrosoft Entra IDユーザー オブジェクトにリンクします。 ユーザーの userPrincipalName がフェデレーション ドメインを使用する場合は、Graph で新しいユーザー アカウントを作成するときに、このプロパティを指定する必要があります。

重要: このプロパティを指定する場合は、$ 文字と _ 文字を使用しないでください。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-JobTitle

ユーザーの役職を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MailNickName

ユーザーのメール アドレスのニックネームを指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Mobile

ユーザーの携帯電話番号を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-OtherMails

ユーザーの他の電子メール アドレスを指定します。

パラメーターのプロパティ

型:

System.Collections.Generic.List`1[System.String]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PasswordPolicies

ユーザーのパスワード ポリシーを指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PasswordProfile

ユーザーのパスワード プロファイルを指定します。

パラメーターのプロパティ

型:PasswordProfile
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PostalCode

ユーザーの郵便番号を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PreferredLanguage

ユーザーの優先言語を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ShowInAddressList

アドレス一覧にこのユーザーを表示するには、True に設定します。

パラメーターのプロパティ

型:System.Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SignInNames

このユーザーのサインイン名の一覧

パラメーターのプロパティ

型:

System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-State

ユーザーの状態を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-StreetAddress

ユーザーの番地を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Surname

ユーザーの姓を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-TelephoneNumber

ユーザーの電話番号を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UsageLocation

2 文字の国または地域コード (ISO 標準 3166)。 国と地域でサービスの可用性を確認する法的要件によりライセンスを割り当てたユーザーに必要です。 たとえば、"US"、"JP"、"GB" などです。null 許容ではありません。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UserId

Microsoft Entra IDのユーザーの ID (ユーザー プリンシパル名または UserId として) を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:オブジェクト識別子, UPN, アイデンティティ, ユーザープリンシパルネーム

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-UserPrincipalName

ユーザーのユーザー プリンシパル名を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UserType

ディレクトリ内のユーザーの種類 ("Member" や "Guest" など) を分類するために使用できる文字列値。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

メモ

Update-EntraUserSet-EntraUser の別名です。