New-App

Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.

Используйте командлет New-App для установки приложений для Outlook.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

New-App
   [-Etoken <String>]
   [-Mailbox <MailboxIdParameter>]
   [-MarketplaceCorrelationID <String>]
   [-MarketplaceAssetID <String>]
   [-MarketplaceQueryMarket <String>]
   [-MarketplaceServicesUrl <String>]
   [-MarketplaceUserProfileType <String>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]
New-App
   [-FileData <Byte[]>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-Mailbox <MailboxIdParameter>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]
New-App
   [-FileStream <Stream>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-Mailbox <MailboxIdParameter>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]
New-App
   [-Url <Uri>]
   [-AllowReadWriteMailbox]
   [-Confirm]
   [-DefaultStateForUser <DefaultStateForUser>]
   [-DomainController <Fqdn>]
   [-DownloadOnly]
   [-Enabled <Boolean>]
   [-Mailbox <MailboxIdParameter>]
   [-OrganizationApp]
   [-PrivateCatalog]
   [-ProvidedTo <ClientExtensionProvidedTo>]
   [-UserList <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

Описание

Если приложение включено для всей организации, пользователи могут активировать новое приложение при просмотре почты или элементов календаря в Майкрософт Outlook или Outlook в Интернете. Если установленное приложение не включено, пользователи могут включить его из Outlook в Интернете параметров. Аналогичным образом администраторы могут включить установленные приложения из Центра администрирования Exchange или с помощью командлета Enable-App или Set-App.

Дополнительные сведения см. в разделах Управление доступом пользователей к надстройкам для Outlook в Exchange Server и Управление развертыванием надстроек в Центр администрирования Microsoft 365.

Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.

Примеры

Пример 1

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

В этом примере устанавливается файл манифеста приложения Finance Test, скопированный на локальный жесткий диск.

Пример 2

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

В этом примере устанавливается файл manifest.xml приложения Contoso CRM с URL-адреса в корпоративной сети Contoso. Сервер Exchange должен иметь доступ к целевому URL-адресу. Это приложение устанавливается как приложение организации, оно доступно определенному списку пользователей и включено для этих пользователей по умолчанию.

Параметры

-AllowReadWriteMailbox

Параметр AllowReadWriteMailbox указывает, разрешает ли приложение разрешение на чтение и запись почтового ящика. Для этого переключателя не требуется указывать значение.

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

-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 указывает начальное состояние по умолчанию приложения организации. Допустимые значения:

  • Включено: приложение организации включено по умолчанию.
  • Отключено: приложение организации отключено по умолчанию. Это значение используется по умолчанию.
  • 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. Вы определяете контроллер домена по его полному доменному имени (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

-DownloadOnly

Переключатель DownloadOnly определяет, следует ли получить файл манифеста приложения и запросить подтверждение пользователя, прежде чем приступать к установке. Для этого переключателя не требуется указывать значение.

При использовании этого параметра командлет лишь скачивает файл манифеста приложения и отображает свойства приложения, не устанавливая его.

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, Exchange Online Protection

-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

-Etoken

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

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

-FileData

Параметр FileData указывает расположение файла манифеста приложения. Необходимо указать только одно исходное расположение для файла манифеста приложения. Файл манифеста приложения можно указать с помощью параметра MarketplaceServicesUrl, Url или FileData.

Допустимое значение для этого параметра требует считывания файла в байтовый объект с использованием следующего синтаксиса: ([System.IO.File]::ReadAllBytes('<Path>\<FileName>')). Эту команду можно использовать в качестве значения параметра или записать выходные данные в переменную ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')) и использовать переменную в качестве значения параметра ($data).

Type:Byte[]
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

-FileStream

Параметр FileStream используется только Центром администрирования Exchange для поддержки средства отправки файлов приложений. Не используйте этот параметр для указания файла манифеста приложения. Файл манифеста приложения можно указать с помощью параметра MarketplaceServicesUrl, URL-адрес или FileData.

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

-Mailbox

Параметр Mailbox указывает почтовый ящик, в который требуется установить приложение. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Например:

  • Имя
  • Псевдоним
  • различающееся имя (DN);
  • различающееся имя (DN);
  • Домен\Имя пользователя
  • Адрес электронной почты
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • Идентификатор пользователя или имя участника-пользователя
Type:MailboxIdParameter
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

-MarketplaceAssetID

Параметр MarketplaceAssetID указывает идентификатор магазина Office для приложения. Этот параметр необходимо использовать, если вы используете параметр MarketplaceServicesUrl.

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

-MarketplaceCorrelationID

Параметр MarketplaceCorrelationID указывает идентификатор корреляции Магазина Office для приложения.

Type:String
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, Exchange Online Protection

-MarketplaceQueryMarket

Параметр MarketplaceQueryMarket определяет языковой стандарт, к которому отнесено приложение в Office Marketplace. Например, приложение для рынка Соединенных Штатов на английском языке использует значение en-US. Значение по умолчанию — en-US.

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

-MarketplaceServicesUrl

Параметр MarketplaceServicesUrl указывает URL-адрес полного спектра услуг для приложения. Необходимо указать только одно исходное расположение для файла манифеста приложения. Файл манифеста приложения можно указать с помощью параметра MarketplaceServicesUrl, URL-адрес или FileData.

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

-MarketplaceUserProfileType

Параметр MarketplaceUserProfileType указывает тип профиля пользователя для Магазина Office.

Type:String
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, 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 указывает доступность приложения в организации. Допустимые значения:

  • Все: это значение по умолчанию. Это приложение предоставляется каждому пользователю в организации. Каждый пользователь видит это приложение в списке установленных приложений в разделе Параметры Outlook в Интернете. При включении приложения в списке установленных приложений пользователи могут использовать функции этого приложения в своей электронной почте. Пользователям не заблокирована возможность устанавливать собственные копии этого приложения, включая, но не ограничиваясь пользователями, имеющими разрешение на установку приложений.
  • 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

-Url

Параметр Url указывает полный URL-адрес расположения файла манифеста приложения, которое требуется установить. Необходимо указать только одно исходное расположение для файла манифеста приложения. Файл манифеста приложения можно указать с помощью параметра MarketplaceServicesUrl, URL-адрес или FileData.

Примечание. URL-адреса с перенаправлениями не поддерживаются в Exchange Server 2016, Exchange Server 2019 и Exchange Online. Используйте прямой URL-адрес манифеста.

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

-UserList

Параметр UserList указывает, кто может использовать приложение организации. Этот параметр ограничен 1000 пользователями. В облачной службе это значение менее актуально, так как управление надстройками Office переходит на централизованное развертывание.

Допустимые значения — это почтовые ящики или почтовые пользователи в организации. Вы можете использовать любое значение, однозначно определяющее пользователя. Пример:

  • Имя
  • Псевдоним
  • различающееся имя (DN);
  • различающееся имя (DN);
  • Домен\Имя пользователя
  • Адрес электронной почты
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • Идентификатор пользователя или имя участника-пользователя

Update Если значения содержат пробелы или иным образом требуют кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Этот параметр можно использовать вместе с параметром 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

Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.