New-ServicePrincipal
このコマンドレットは、クラウドベースのサービスでのみ使用できます。
New-ServicePrincipal コマンドレットを使用して、クラウドベースのorganizationでサービス プリンシパルを作成します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
New-ServicePrincipal
-AppId <String>
-ObjectId <String>
-ServiceId <String>
[-Confirm]
[-DisplayName <String>]
[-Organization <OrganizationIdParameter>]
[-WhatIf]
[<CommonParameters>]
説明
サービス プリンシパルはMicrosoft Entra IDに存在し、アプリで実行できる操作、アプリにアクセスできるユーザー、アプリがアクセスできるリソースを定義します。 Exchange Onlineでは、サービス プリンシパルは、Microsoft Entra IDのサービス プリンシパルへの参照です。 Exchange Onlineロールベースのアクセス制御 (RBAC) ロールをMicrosoft Entra IDのサービス プリンシパルに割り当てるには、Exchange Onlineのサービス プリンシパル参照を使用します。 Exchange Online PowerShell の *-ServicePrincipal コマンドレットを使用すると、これらのサービス プリンシパル参照を表示、作成、および削除できます。
詳細については、「Microsoft Entra IDのアプリケーション および サービス プリンシパル オブジェクト」を参照してください。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
New-ServicePrincipal -AppId 71487acd-ec93-476d-bd0e-6c8b31831053 -ObjectId 6233fba6-0198-4277-892f-9275bf728bcc
次の使用例は、指定した AppId 値と ObjectId 値を使用して、Exchange Onlineに新しいサービス プリンシパルを作成します。
パラメーター
-AppId
適用対象: Exchange Online、セキュリティ & コンプライアンス、オンプレミス メールボックスの組み込みのセキュリティ アドオン
AppId パラメーターは、サービス プリンシパルの一意の AppId GUID 値を指定します。 たとえば、ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1 です。
このパラメーターの有効な値は、次の場所で使用できます。
- Microsoft Graph PowerShell の Get-MgServicePrincipal コマンドレットの出力の AppId プロパティ。
- Microsoft Entra 管理センター: https://portal.azure.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/~/AppAppsPreview/menuId~/nullの Enterprise アプリケーションのアプリケーション ID プロパティ。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-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 |
-ObjectId
適用対象: Exchange Online、セキュリティ & コンプライアンス、オンプレミス メールボックスの組み込みのセキュリティ アドオン
ObjectId パラメーターは、サービス プリンシパルの一意の ObjectId GUID 値を指定します。 たとえば、7c7599b2-23af-45e3-99ff-0025d148e929 です。
このパラメーターの有効な値は、次の場所で使用できます。
- Microsoft Graph PowerShell の Get-MgServicePrincipal コマンドレットの出力の Id プロパティ。
- Microsoft Entra 管理センター: https://portal.azure.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/~/AppAppsPreview/menuId~/nullの Enterprise アプリケーションの Object ID プロパティ。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Organization
適用対象: セキュリティ & コンプライアンス
このパラメーターは、Microsoft の内部使用のために予約されています。
パラメーターのプロパティ
| 型: | OrganizationIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ServiceId
適用対象: Exchange Online、セキュリティ & コンプライアンス、オンプレミス メールボックスの組み込みのセキュリティ アドオン
このパラメーターは非推奨になっています。 代わりに ObjectId パラメーターを使用します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | 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」を参照してください。