TechNet
Export (0) Print
Expand All

Set-App

 

Applies to: Exchange Online, Exchange Server 2016

Topic Last Modified: 2016-08-23

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-App cmdlet to modify the availability of organization apps.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-App -Identity <AppIdParameter> [-Confirm [<SwitchParameter>]] [-DefaultStateForUser <Enabled | Disabled | AlwaysEnabled>] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-OrganizationApp <SwitchParameter>] [-PrivateCatalog <SwitchParameter>] [-ProvidedTo <Everyone | SpecificUsers>] [-UserList <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

This example changes the organization app FinanceTestApp, which was installed to everyone in the organization, to be provided to specific users on the finance team and to be enabled by default.

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

For more information, see Manage user access to apps for Outlook.

This example disables the organization app FinanceTestApp across the organization and hides it from end user view.

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

For more information, see Manage user access to apps for Outlook.

The Set-App cmdlet can only be used when configuring the availability of an organization app. This task requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Outlook).

Default apps in Outlook on the web and apps that you've installed for use by users in your organization are known as organization apps. Organization apps can't be removed by end users, but can be enabled or disabled. If an app is an organization app (scope default or organization), the delete control on the toolbar is disabled for end users. Administrators are able to remove organization apps. Administrators can't remove default apps, but they can disable them for the entire organization.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Apps for Outlook" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.AppIdParameter

The Identity parameter specifies the GUID of the app. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DefaultStateForUser

Optional

Microsoft.Exchange.Management.Extension.DefaultStateForUser

The DefaultStateForUser parameter specifies the default initial state of the organization app for the specified users.

The possible values are:

  • Enabled    The organization app is enabled.

  • Disabled   The organization app is disabled. This is the default value.

  • AlwaysEnabled    The organization app is enabled, and users can't disable it.

You use this parameter with the OrganizationApp switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the app is available to users in the organization. Valid values are:

  • $true   The app is enabled for the specified users. This is the default value.

  • $false   The app isn't enabled for any users in the organization. This hides the app from user view for all users.

CautionCaution:
This setting overrides the ProvidedTo, UserList, and DefaultStateForUser settings. This setting doesn't prevent users from installing their own instance of the app if they have install permissions.

OrganizationApp

Optional

System.Management.Automation.SwitchParameter

The OrganizationApp switch specifies that the scope of the app is organizational (not bound to a specific user). You don't need to specify a value with this switch.

PrivateCatalog

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

ProvidedTo

Optional

Microsoft.Exchange.Data.ApplicationLogic.Extension.ClientExtensionProvidedTo

The ProvidedTo parameter specifies the availability of the app in your organization. Valid value are:

  • Everyone   The app is provided to every user in the organization. This is the default value.

    Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions.

  • SpecificUsers   This app is provided to only the users specified by the UserList parameter. All other users don't see this organizational app in their management view, nor will it activate in their mail or calendar items. The specified users are also blocked from installing their own instance of this app. Unlisted users aren't blocked from installing their own instance of this app.

You use this parameter with the OrganizationApp switch.

UserList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UserList parameter specifies who can usean organizational app. Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

You use this parameter with the OrganizationApp switch.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show:
© 2016 Microsoft