Set-App

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

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

Set-App コマンドレットを使用して、組織アプリケーションの可用性を変更します。

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

構文

Set-App
   [-Identity] <AppIdParameter>
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-Enabled <Boolean>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

説明

Set-App コマンドレットは、組織アプリの使用可能状況を構成するときにのみ使用できます。 このタスクでは、指定したアプリが既にインストールされている必要があります (たとえば、アプリが New-App コマンドレットと共にインストールされていること、または Outlook の既定のアプリである場合など)。

Outlook on the webの既定のアプリと、組織内のユーザーが使用するためにインストールしたアプリは、組織のアプリと呼ばれます。 エンド ユーザーは、組織アプリを削除できませんが、有効にしたり無効にしたりすることはできます。 アプリが組織アプリ (スコープの既定または組織) である場合、エンド ユーザーはツールバーの削除コントロールを使用できません。 管理者は組織アプリを削除できます。 管理者は既定アプリを削除できませんが、組織全体で既定アプリを無効にすることはできます。

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

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

例

例 1

$a= Get-DistributionGroupMember -Identity "Finance Team"

Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -ProvidedTo SpecificUsers -UserList $a.Identity -DefaultStateForUser Enabled

この例では、組織のすべてのユーザー用にインストールされている FinanceTestApp という組織アプリを変更し、ファイナンス チームのグループ メンバーにこのアプリを提供して、既定で有効にします。

例 2

Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -Enabled $false

この例では、組織全体で FinanceTestApp という組織アプリを無効にし、エンド ユーザーに表示されないようにします。

パラメーター

-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 パラメーターは、指定したユーザー用に組織アプリの既定の初期状態を指定します。 有効な値は次のとおりです。

  • Enabled: 組織アプリは有効です。
  • Disabled: 組織アプリは無効です。 これは既定の値です。
  • 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

-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

-Identity

Identity パラメーターは、変更するアプリの AppID (GUID 値) を指定します。 アプリの GUID 値を確認するには、コマンド Get-App | Format-Table -Auto DisplayName,AppId を実行します。

Type:AppIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, 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 パラメーターは、組織でのアプリの使用可能状況を指定します。 有効な値は次のとおりです。

  • Everyone: このアプリを組織のすべてのユーザーに提供します。 これは既定の値です。 すべてのユーザーには、インストールされているアプリの一覧の [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

-UserList

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

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

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

Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN" リストの最大サイズは 1,000 受信者です。

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

Type:MultiValuedProperty
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

-WhatIf

WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。

Type:SwitchParameter
Aliases:wi
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

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。