Set-ServicePrincipal
このコマンドレットは、クラウドベースのサービスでのみ使用できます。
Set-ServicePrincipal コマンドレットを使用して、クラウドベースのorganizationのサービス プリンシパルを変更します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Set-ServicePrincipal
[-Identity] <ServicePrincipalIdParameter>
[-Confirm]
[-DisplayName <String>]
[-WhatIf]
[<CommonParameters>]
説明
このコマンドレットを使用すると、DisplayName のみを変更できます。 AppId/ObjectId が間違っている場合は、サービス プリンシパルを削除し、新しいプリンシパルを作成します。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-ServicePrincipal -Identity dc873ad4-0397-4d74-b5c0-897cd3a94731 -DisplayName "Another App Name"
次の使用例は、指定した表示名を使用して、Exchange Onlineのサービス プリンシパルを設定します。
パラメーター
-Confirm
適用対象: Exchange Online、セキュリティ & コンプライアンス、オンプレミス メールボックスの組み込みのセキュリティ アドオン
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 この切り替えがコマンドレットにどのように影響するかは、続行する前にコマンドレットで確認が必要かどうかによって異なります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットでは、値を指定せずに [確認] スイッチを指定すると、続行する前にコマンドの確認を強制する一時停止が発生します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DisplayName
適用対象: Exchange Online、セキュリティ & コンプライアンス、オンプレミス メールボックスの組み込みのセキュリティ アドオン
DisplayName パラメーターは、サービス プリンシパルのフレンドリ名を指定します。 名前にスペースが含まれている場合、名前を二重引用符 (") で囲みます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Online、セキュリティ & コンプライアンス、オンプレミス メールボックスの組み込みのセキュリティ アドオン
Identity パラメーターは、変更するサービス プリンシパルを指定します。 サービス プリンシパルを一意に識別する任意の値を使用できます。 例:
- 名前
- 識別名 (DN)
- GUID
- Appid
- ObjectId
パラメーターのプロパティ
| 型: | ServicePrincipalIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
WhatIf スイッチは、セキュリティ/コンプライアンス PowerShell では機能しません。
WhatIf スイッチは、変更を加えずにコマンドの動作を示します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。