New-App

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

このコマンドレットは、オンプレミスの Exchange およびクラウドベースのサービスで使用できます。一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。

New-App コマンドレットを使用して、Outlook 用アプリをインストールします。

以下の構文セクションのパラメーターセットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

New-App
   [-Etoken <String>]
   [-Mailbox <MailboxIdParameter>]
   [-MarketplaceCorrelationID <String>]
   [-MarketplaceAssetID <String>]
   [-MarketplaceQueryMarket <String>]
   [-MarketplaceServicesUrl <String>]
   [-MarketplaceUserProfileType <String>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

New-App
   [-FileData <Byte[]>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-Mailbox <MailboxIdParameter>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

New-App
   [-FileStream <Stream>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-Mailbox <MailboxIdParameter>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

New-App
   [-Url <Uri>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-Mailbox <MailboxIdParameter>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

説明

組織全体でアプリが有効になっている場合、ユーザーは Outlook またはOutlook on the web内のメールまたは予定表アイテムを表示するときに、新しいアプリMicrosoftアクティブ化できます。インストールされているアプリが有効になっていない場合、ユーザーは Outlook on the web オプションからアプリを有効にすることができます。同様に、管理者は、Exchange 管理センターから、または Enable-App または Set-App コマンドレットを使用して、インストールされたアプリを有効にすることができます。

詳細については、「Exchange Serverでの Outlook 用アドインへのユーザーアクセスの管理」および「Microsoft 365 管理センターでのアドインの展開の管理」を参照してください。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

New-App -FileData ([System.IO.File]::ReadAllBytes('C:\Apps\FinanceTestApp.xml'))

次の使用例は、ローカルハードディスクにコピーされた Finance Test アプリマニフェストファイルをインストールします。

例 2

New-App -OrganizationApp -Url https://Server01.Contoso.com/apps/ContosoCRMApp/manifest.xml -ProvidedTo SpecificUsers -UserList "user1,user2,user3,user4,user5" -DefaultStateForUser Enabled

次の使用例は、Contoso 企業ネットワーク上の URL から Contoso CRM アプリmanifest.xmlをインストールします。 Exchange サーバーがターゲット URL に到達できる必要があります。このアプリは組織アプリとしてインストールされ、特定のユーザーの一覧で使用できるようになり、既定でそれらのユーザーに対して有効になっています。

パラメーター

-AllowReadWriteMailbox

AllowReadWriteMailbox スイッチは、アプリでメールボックスの読み取り/書き込みアクセス許可を許可するかどうかを指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-DefaultStateForUser

DefaultStateForUser パラメーターは、組織アプリの既定の初期状態を指定します。有効な値は次のとおりです。

有効: 組織アプリは既定で有効になっています。
無効: 組織アプリは既定で無効になっています。これは既定の値です。
AlwaysEnabled: 組織アプリが有効になっており、ユーザーがそれを無効にすることはできません。

このパラメーターを使用する場合は、OrganizationApp スイッチを使用する必要があります。

Type:	DefaultStateForUser
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-DomainController

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメインコントローラーを指定します。ドメインコントローラーは、完全修飾ドメイン名 (FQDN) で識別します。たとえば、dc01.contoso.com です。

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DownloadOnly

DownloadOnly スイッチは、アプリマニフェストファイルを取得し、実際のインストールにコミットする前にユーザーに確認を求めるかどうかを指定します。このスイッチで値を指定する必要はありません。

このスイッチを使用すると、コマンドレットはアプリマニフェストファイルのみをダウンロードし、アプリをインストールせずにアプリのプロパティを表示します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-Enabled

Enabled パラメーターは、組織のユーザーがアプリを使用できるかどうかを指定します。有効な値は次のとおりです。

$true: 指定したユーザーがアプリを使用できます。これは既定の値です。
$false: アプリは組織内のすべてのユーザーから非表示になります。

この設定は、ProvidedTo、UserList、DefaultStateForUser の設定をオーバーライドします。このように設定しても、ユーザーは、インストール権限がある場合、アプリのインスタンスをインストールできます。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Etoken

このパラメーターは、Microsoft の内部使用のために予約されています。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-FileData

FileData パラメーターは、アプリマニフェストファイルの場所を指定します。アプリマニフェストファイルのソースの場所を 1 つだけ指定する必要があります。 MarketplaceServicesUrl、Url、または FileData パラメーターを使用して、アプリマニフェストファイルを指定できます。

このパラメーターの有効な値を使用するには、次の構文を使用して、ファイルをバイトエンコードされたオブジェクトに読み取る必要があります。 ([System.IO.File]::ReadAllBytes('<Path>\<FileName>')) このコマンドをパラメーター値として使用することも、変数 () に出力を書き込み、変数をパラメーター値 ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')$data) として使用することもできます。

Type:	Byte[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-FileStream

FileStream パラメーターは、アプリファイルアップローダーをサポートするために Exchange 管理センターによってのみ使用されます。このパラメーターを使用してアプリマニフェストファイルを指定しないでください。 MarketplaceServicesUrl、Url、または FileData パラメーターを使用して、アプリマニフェストファイルを指定できます。

Type:	Stream
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Mailbox

Mailbox パラメーターは、アプリをインストールするメールボックスを指定します。メールボックスを一意に識別する任意の値を使用できます。例: 次に例を示します。

名前
Alias
識別名 (DN)
正規 DN
Domain\Username
電子メールアドレス
GUID
LegacyExchangeDN
SamAccountName
ユーザー ID またはユーザープリンシパル名 (UPN)

Type:	MailboxIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-MarketplaceAssetID

MarketplaceAssetID パラメーターは、アプリの Office ストア識別子を指定します。 MarketplaceServicesUrl パラメーターを使用する場合は、このパラメーターを使用する必要があります。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-MarketplaceCorrelationID

MarketplaceCorrelationID パラメーターは、アプリの Office ストアの関連付け識別子を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-MarketplaceQueryMarket

MarketplaceQueryMarket パラメーターは、Office Marketplace でアプリが提出されるロケールを指定します。たとえば、英語の米国市場のアプリでは、en-US という値が使用されます。既定値は en-US です。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-MarketplaceServicesUrl

MarketplaceServicesUrl パラメーターは、アプリの完全なサービス URL を指定します。アプリマニフェストファイルのソースの場所を 1 つだけ指定する必要があります。 MarketplaceServicesUrl、Url、または FileData パラメーターを使用して、アプリマニフェストファイルを指定できます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-MarketplaceUserProfileType

MarketplaceUserProfileType パラメーターは、Office ストアのユーザープロファイルの種類を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-OrganizationApp

OrganizationApp スイッチは、アプリのスコープが組織である (特定のユーザーにバインドされていない) ことを指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-PrivateCatalog

PrivateCatalog スイッチは、アプリがプライベートカタログに配置されているかどうかを指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online

-ProvidedTo

ProvidedTo パラメーターは、組織でのアプリの使用可能状況を指定します。有効な値は次のとおりです。

全員: これが既定値です。このアプリは、組織内のすべてのユーザーに提供されます。すべてのユーザーには、インストールされているアプリの一覧の [Outlook on the web オプション] にこのアプリが表示されます。インストールされたアプリのリストで、アプリが有効として表示されている場合は、このアプリの機能を電子メールで使用できます。アプリをインストールする権限があるユーザーを含むすべてのユーザーが、このアプリのインスタンスをインストールできません。
SpecificUsers: このアプリは、UserList パラメーターで指定されたユーザーにのみ提供されます。他のすべてのユーザーは、管理ビューにこの組織アプリを表示することも、メールや予定表アイテムでアクティブ化することもありません。指定されたユーザーは、このアプリの独自のインスタンスのインストールもブロックされます。一覧に記載されていないユーザーは、このアプリの独自のインスタンスのインストールをブロックされません。

このパラメーターは OrganizationApp スイッチと併用します。

Type:	ClientExtensionProvidedTo
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Url

Url パラメーターは、インストールするアプリマニフェストファイルの完全な URL の場所を指定します。アプリマニフェストファイルのソースの場所を 1 つだけ指定する必要があります。 MarketplaceServicesUrl、Url、または FileData パラメーターを使用して、アプリマニフェストファイルを指定できます。

注: リダイレクトを含む URL は、Exchange Server 2016、Exchange Server 2019、およびExchange Onlineではサポートされていません。マニフェストへの直接 URL を使用します。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-UserList

UserList パラメーターは、組織のアプリを使用できるユーザーを指定します。このパラメーターのユーザー数は 1,000 人に制限されています。クラウドベースのサービスでは、Office アドイン管理が一元展開に移行するため、この値の関連性は低くなります。

正しい値は、組織内のメールボックスまたはメールユーザーです。ユーザーを一意に識別する任意の値を使用できます。以下に例を示します。

名前
Alias
識別名 (DN)
正規 DN
Domain\Username
電子メールアドレス
GUID
LegacyExchangeDN
SamAccountName
ユーザー ID またはユーザープリンシパル名 (UPN)

Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"