Commands › Exchange Online

Set-App

Exchange Online ExchangeOnlineManagement Set-*

Modify the availability of organization apps.

Quick start script

# Set-App — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-App
$before | Format-List

# 3. Make the change (dry run first)
Set-App -Identity <AppIdParameter> -WhatIf
Set-App -Identity <AppIdParameter>

# 4. Verify and diff
$after = Get-App
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

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

Parameters (10)

ParameterTypeRequiredWhat it controls
-Identity AppIdParameter yes The Identity parameter specifies the AppID (GUID value) of the app that you want to modify. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId.
-Confirm SwitchParameter The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DefaultStateForUser DefaultStateForUser The DefaultStateForUser parameter specifies the default initial state of the organization app for the specified users. Valid values are:
-DomainController Fqdn This parameter is available only in on-premises Exchange.
-Enabled Boolean The Enabled parameter specifies whether the app is available to users in the organization. Valid values are:
-OrganizationApp 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 SwitchParameter The PrivateCatalog switch specifies that the app you want to modify is located in a private catalog. You don't need to specify a value with this switch.
-ProvidedTo ClientExtensionProvidedTo The ProvidedTo parameter specifies the availability of the app in your organization. Valid value are:
-UserList MultiValuedProperty The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to...
-WhatIf SwitchParameter The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.