[Index]

Model: device/exchangeonline/App

Model Details

Title Description Details
DisplayName
  • Field Name: DisplayName
  • Type: String
ProviderName
  • Field Name: ProviderName
  • Type: String
FileStream The FileStream parameter is used only by the Exchange admin center to support the app file uploader. Don't use this parameter to specify the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.
  • Field Name: FileStream
  • Type: String
MarketplaceQueryMarket The MarketplaceQueryMarket parameter specifies the locale that an app is filed under at the office marketplace. For example, an app for the United States market in English uses the value en-US. The default value isen-US.
  • Field Name: MarketplaceQueryMarket
  • Type: String
Etoken This parameter is reserved for internal Microsoft use.
  • Field Name: Etoken
  • Type: String
AllowReadWriteMailbox PARAMVALUE: SwitchParameter
  • Field Name: AllowReadWriteMailbox
  • Type: Boolean
Requirements
  • Field Name: Requirements
  • Type: String
MarketplaceServicesUrl The MarketplaceServicesUrl parameter specifies the full services URL for the app. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.
  • Field Name: MarketplaceServicesUrl
  • Type: String
Scope
  • Field Name: Scope
  • Type: String
Type
  • Field Name: Type
  • Type: String
LicenseType
  • Field Name: LicenseType
  • Type: String
Description
  • Field Name: Description
  • Type: String
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
PSComputerName
  • Field Name: PSComputerName
  • Type: String
Mailbox The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: 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)
  • Field Name: Mailbox
  • Type: String
UserList 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, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>". You use this parameter with the OrganizationApp switch.
  • Field Name: UserList.[n]
  • Type: Array
AppStatus
  • Field Name: AppStatus
  • Type: String
ManifestXml
  • Field Name: ManifestXml
  • Type: String
FileData The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, ([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0)).
  • Field Name: FileData
  • Type: String
Identity The Identity parameter specifies the GUID of the app.
  • Field Name: Identity
  • Type: String
SeatsPurchased
  • Field Name: SeatsPurchased
  • Type: String
Url The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter.
  • Field Name: Url
  • Type: String
MarketplaceContentMarket
  • Field Name: MarketplaceContentMarket
  • Type: String
Enabled The Enabled parameter specifies whether the app is available to users in the organization. Valid values are: $true The app is available to the specified users. This is the default value. $false The app is hidden from all users in the organization. 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.
  • Field Name: Enabled
  • Type: Boolean
AppVersion
  • Field Name: AppVersion
  • Type: String
LicensePurchaser
  • Field Name: LicensePurchaser
  • Type: String
MarketplaceCorrelationID PARAMVALUE: String
  • Field Name: MarketplaceCorrelationID
  • Type: String
MarketplaceAssetID The MarketplaceAssetID parameter specifies the office store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter.
  • Field Name: MarketplaceAssetID
  • Type: String
EtokenExpirationDate
  • Field Name: EtokenExpirationDate
  • Type: String
OrganizationApp The OrganizationAppswitch 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.
  • Field Name: OrganizationApp
  • Type: Boolean
DomainController 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.
  • Field Name: DomainController
  • Type: String
DefaultStateForUser The DefaultStateForUser parameter specifies the default initial state of an organization app. Valid values are: Enabled The organization app is enabled by default. Disabled The organization app is disabled by default. This is the default value. AlwaysEnabled The organization app is enabled, and users can't disable it. You need to use the OrganizationApp switch when you use this parameter.
  • Field Name: DefaultStateForUser
  • Type: String
MailboxOwnerId
  • Field Name: MailboxOwnerId
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
DownloadOnly The DownloadOnly switch specifies whether to get the app manifest file and prompt the user for confirmation before committing to actual installation. You don't need to specify a value with this switch. When you use this switch, the cmdlet only downloads the app manifest file and displays the app properties without installing the app.
  • Field Name: DownloadOnly
  • Type: Boolean
PrivateCatalog PARAMVALUE: SwitchParameter
  • Field Name: PrivateCatalog
  • Type: Boolean
IconURL
  • Field Name: IconURL
  • Type: String
ObjectState
  • Field Name: ObjectState
  • Type: String
ProvidedTo The ProvidedTo parameter specifies the availability of the app in your organization. Valid values are: 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.
  • Field Name: ProvidedTo
  • Type: String
AppId
  • Field Name: AppId
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
MarketplaceUserProfileType PARAMVALUE: String
  • Field Name: MarketplaceUserProfileType
  • Type: String
API reference for device/exchangeonline/App