New-ServicePrincipal
このコマンドレットは、クラウドベースのサービスでのみ使用できます。
New-ServicePrincipal コマンドレットを使用して、クラウドベースのorganizationでサービス プリンシパルを作成します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
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、セキュリティ & コンプライアンス、Exchange Online Protection
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 |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
適用対象: Exchange Online、セキュリティ & コンプライアンス、Exchange Online Protection
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$false
を使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisplayName
適用対象: Exchange Online、セキュリティ & コンプライアンス、Exchange Online Protection
DisplayName パラメーターは、サービス プリンシパルのフレンドリ名を指定します。 名前にスペースが含まれている場合、名前を二重引用符 (") で囲みます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ObjectId
適用対象: Exchange Online、セキュリティ & コンプライアンス、Exchange Online Protection
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 |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Organization
適用対象: セキュリティ & コンプライアンス
このパラメーターは、Microsoft の内部使用のために予約されています。
型: | OrganizationIdParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ServiceId
適用対象: Exchange Online、セキュリティ & コンプライアンス、Exchange Online Protection
このパラメーターは非推奨になっています。 代わりに ObjectId パラメーターを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
適用対象: Exchange Online、セキュリティ & コンプライアンス、Exchange Online Protection
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |