Set-MsolServicePrincipal
Microsoft Azure Active Directory のサービス プリンシパルを更新します。
構文
Set-MsolServicePrincipal
[-ObjectId <Guid>]
[-AppPrincipalId <Guid>]
[-DisplayName <String>]
[-ServicePrincipalNames <String[]>]
[-AccountEnabled <Boolean>]
[-Addresses <RedirectUri[]>]
[-TenantId <Guid>]
[<CommonParameters>]
説明
Set-MsolServicePrincipal コマンドレットは、Microsoft Azure Active Directory のサービス プリンシパルを更新します。 これは、表示名の更新、委任のために信頼されているサービス プリンシパル、サービス プリンシパル名 (SPN) またはアドレスの有効化または無効化に使用できます。
例
例 1: サービス プリンシパルのプロパティを変更する
PS C:\> $AppId = (Get-MsolServicePrincipal -ServicePrincipalName "MyApp").AppPrincipalId
PS C:\> Set-MsolServicePrincipal -AppPrincipalId $AppId -DisplayName "My Super Application" -ServicePrincipalNames @("MyApp/myapp.com", "MyApp/mysuperapp.com")
このコマンドは、指定されたサービス プリンシパルのプロパティを更新します。 この例では、表示名と SPN の更新を指定します。 これにより、以前の設定が上書きされます。
例 2: サービス プリンシパルのアドレスを変更する
PS C:\> $a = @()
PS C:\> $a = $a + (Get-MsolServicePrincipal -ServicePrincipalName "MyApp").Addresses
PS C:\> $a = $a + (New-MsolServicePrincipalAddresses -Value "myApp1.com")
PS C:\> $a = $a + (New-MsolServicePrincipalAddresses -Value "myApp2.com")
PS C:\> Set-MsolServicePrincipal -AppPrincipalId $AppId -Addresses $a
このコマンドは、サービス プリンシパルのアドレスを更新します。 この例では、 New-MsolServicePrincipalAddresses コマンドレットを使用して以前に作成された既存のアドレス ("myApp1.com"、"myApp2.com") がサービス プリンシパルに関連付けられています。
パラメーター
-AccountEnabled
このプロパティは、今後使用するために予約されています。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Addresses
既存のリストを更新および上書きするアドレス一覧を指定します。 このパラメーターを指定しない場合、既存のプロパティは更新されません。 空のリストを指定すると、既存のアドレスがクリアされます。 Address リスト オブジェクトを作成するには、 New-MsolServicePrincipalAddress コマンドレットを使用します。
型: | RedirectUri[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AppPrincipalId
更新するサービス プリンシパルに関連付けられている一意のアプリケーション ID を指定します。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DisplayName
サービス プリンシパルの表示名を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ObjectId
更新するサービス プリンシパルの一意のオブジェクト ID を指定します。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ServicePrincipalNames
既存のものを更新および上書きする SPN の一覧を指定します。 このパラメーターを指定しない場合、既存のプロパティは更新されません。 空のリストを指定すると、サービス プリンシパルの AppId 値を含む SPN を除き、既存の SPN はクリアされます。 SPN では、次のいずれかの形式を使用する必要があります。
appName
appName/hostname
- 有効な URL
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TenantId
操作を実行するテナントの一意の ID を指定します。 既定値は、現在のユーザーのテナントです。 このパラメーターは、パートナー ユーザーにのみ適用されます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |