New-App

構文

ExtensionOfficeMarketplace

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

ExtensionFileData

New-App
    [-FileData <Byte[]>]
    [-AddInOverrides <AddInOverrides>]
    [-AllowReadWriteMailbox]
    [-AllowSetting <AllowSetting>]
    [-AppState <String>]
    [-AppType <String>]
    [-Confirm]
    [-DefaultStateForUser <DefaultStateForUser>]
    [-DomainController <Fqdn>]
    [-DownloadOnly]
    [-Enabled <Boolean>]
    [-Identity <String>]
    [-Mailbox <MailboxIdParameter>]
    [-OrganizationApp]
    [-PrivateCatalog]
    [-ProvidedTo <ClientExtensionProvidedTo>]
    [-UpdateAppState]
    [-UserList <MultiValuedProperty>]
    [-Version <String>]
    [-WhatIf]
    [<CommonParameters>]

ExtensionFileStream

New-App
    [-FileStream <Stream>]
    [-AddInOverrides <AddInOverrides>]
    [-AllowReadWriteMailbox]
    [-AllowSetting <AllowSetting>]
    [-AppState <String>]
    [-AppType <String>]
    [-Confirm]
    [-DefaultStateForUser <DefaultStateForUser>]
    [-DomainController <Fqdn>]
    [-DownloadOnly]
    [-Enabled <Boolean>]
    [-Identity <String>]
    [-Mailbox <MailboxIdParameter>]
    [-OrganizationApp]
    [-PrivateCatalog]
    [-ProvidedTo <ClientExtensionProvidedTo>]
    [-UpdateAppState]
    [-UserList <MultiValuedProperty>]
    [-Version <String>]
    [-WhatIf]
    [<CommonParameters>]

ExtensionPrivateURL

New-App
    [-Url <Uri>]
    [-AddInOverrides <AddInOverrides>]
    [-AllowReadWriteMailbox]
    [-AllowSetting <AllowSetting>]
    [-AppState <String>]
    [-AppType <String>]
    [-Confirm]
    [-DefaultStateForUser <DefaultStateForUser>]
    [-DomainController <Fqdn>]
    [-DownloadOnly]
    [-Enabled <Boolean>]
    [-Identity <String>]
    [-Mailbox <MailboxIdParameter>]
    [-OrganizationApp]
    [-PrivateCatalog]
    [-ProvidedTo <ClientExtensionProvidedTo>]
    [-UpdateAppState]
    [-UserList <MultiValuedProperty>]
    [-Version <String>]
    [-WhatIf]
    [<CommonParameters>]

説明

例

例 1

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

例 2

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

パラメーター

-AddInOverrides

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill AddInOverrides description }}

パラメーターのプロパティ

パラメーター セット

-AllowReadWriteMailbox

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

パラメーターのプロパティ

パラメーター セット

-AllowSetting

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill AllowSetting description }}

パラメーターのプロパティ

パラメーター セット

-AppState

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill AppState Description }}

パラメーターのプロパティ

パラメーター セット

-AppType

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill AppType description }}

パラメーターのプロパティ

パラメーター セット

-Confirm

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

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

パラメーターのプロパティ

パラメーター セット

-DefaultStateForUser

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

DefaultStateForUser パラメーターは、organization アプリのデフォルトの初期状態を指定します。 有効な値は次のとおりです。

• 有効: organization appはデフォルトで有効になっています。
• 無効: organization app は既定で無効になっています。 この値が既定値です。
• AlwaysEnabled: organization app は有効になっていますが、ユーザーは無効にできません。

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

パラメーターのプロパティ

パラメーター セット

-DomainController

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

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

パラメーターのプロパティ

パラメーター セット

-DownloadOnly

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

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

パラメーターのプロパティ

パラメーター セット

-Enabled

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

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

パラメーターのプロパティ

パラメーター セット

-Etoken

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

パラメーター セット

-FileData

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

パラメーターのプロパティ

パラメーター セット

-FileStream

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

パラメーターのプロパティ

パラメーター セット

-Identity

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill Identity Description }}

パラメーターのプロパティ

パラメーター セット

-Mailbox

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

パラメーターのプロパティ

パラメーター セット

-MarketplaceAssetID

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

パラメーター セット

-MarketplaceCorrelationID

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

パラメーター セット

-MarketplaceQueryMarket

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

パラメーター セット

-MarketplaceServicesUrl

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

パラメーター セット

-MarketplaceUserProfileType

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

パラメーター セット

-OrganizationApp

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

パラメーターのプロパティ

パラメーター セット

-PrivateCatalog

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

パラメーターのプロパティ

パラメーター セット

-ProvidedTo

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

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

パラメーターのプロパティ

パラメーター セット

-UpdateAppState

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill: UpdateAppState Description }}

パラメーターのプロパティ

パラメーター セット

-Url

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

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

パラメーターのプロパティ

パラメーター セット

-UserList

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

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

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

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

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

パラメーターのプロパティ

パラメーター セット

-Version

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

{{ Fill Version Description }}

パラメーターのプロパティ

パラメーター セット

-WhatIf

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

[WhatIf] スイッチは、何も変更を加えずにコマンドが実行する内容を表示します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

Input types

出力

Output types