Set-EntraApplication

Обновляет свойства объекта приложения.

Синтаксис

Default (По умолчанию)

Set-EntraApplication

    -ApplicationId <String>
    [-PasswordCredentials <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]>]
    [-TokenEncryptionKeyId <String>]
    [-SignInAudience <String>]
    [-KeyCredentials <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]>]
    [-ParentalControlSettings <ParentalControlSettings>]
    [-IdentifierUris <System.Collections.Generic.List`1[System.String]>]
    [-AppRoles <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]>]
    [-PublicClient <PublicClientApplication>]
    [-InformationalUrl <InformationalUrl>]
    [-Tags <System.Collections.Generic.List`1[System.String]>]
    [-Api <ApiApplication>]
    [-OptionalClaims <OptionalClaims>]
    [-GroupMembershipClaims <String>]
    [-Web <WebApplication>]
    [-DisplayName <String>]
    [-IsFallbackPublicClient <Boolean>]
    [-IsDeviceOnlyAuthSupported <Boolean>]
    [-RequiredResourceAccess <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]>]
    [<CommonParameters>]

Описание

Обновляет свойства объекта приложения.

Примеры

Пример 1. Обновление приложения

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
$params = @{
    ApplicationId = $application.Id
    DisplayName = 'Contoso Entra PowerShell App Production'
    IdentifierUris = 'https://contoso.com'
    GroupMembershipClaims = 'SecurityGroup'
    IsDeviceOnlyAuthSupported = $False
    Tags = 'mytag'
}
Set-EntraApplication @params

Эта команда обновляет приложение в Microsoft Entra ID.

Пример 2. Обновление приложения с помощью параметра IdentifierUris

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
Set-EntraApplication -ApplicationId $application.Id -IdentifierUris 'https://mynewapp.contoso.com'

Эта команда обновляет приложение в Microsoft Entra ID.

Пример 3. Обновление приложения с помощью параметра GroupMembershipClaims

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
Set-EntraApplication -ApplicationId $application.Id -GroupMembershipClaims 'SecurityGroup'

Эта команда обновляет приложение в Microsoft Entra ID.

Пример 4. Обновление приложения с помощью параметра IsDeviceOnlyAuthSupported

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
Set-EntraApplication -ApplicationId $application.Id -IsDeviceOnlyAuthSupported $False

Эта команда обновляет приложение в Microsoft Entra ID.

Пример 5. Обновление приложения с помощью параметра Тегов

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
Set-EntraApplication -ApplicationId $application.Id -Tags 'mytag'

Эта команда обновляет приложение в Microsoft Entra ID.

Пример 6. Добавление роли (AppRole) в приложение

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -SearchString 'Contoso Helpdesk Application'
$appRole = New-Object Microsoft.Open.MSGraph.Model.AppRole
$appRole.AllowedMemberTypes = @("User", "Application")
$appRole.Description = "General role"
$appRole.DisplayName = "General"
$appRole.Id = [guid]::NewGuid()
$appRole.IsEnabled = $true
$appRole.Value = "General"
$tags = "WindowsAzureActiveDirectoryIntegratedApp"
Set-EntraApplication -ApplicationId $application.Id -AppRoles $appRole -Tags $tags

Эта команда добавляет роль приложения в приложение. Чтобы сохранить существующие роли приложения, включите их в запрос. Все роли, не включенные, будут заменены. Этот объект синхронизируется с соответствующим свойством субъекта-службы в клиенте.

Эти AllowedMemberTypes значения могут принимать следующие значения:

  • @("User", "Application") — для пользователей, групп и приложений.
  • "User" — для пользователей и групп.
  • "Application" — для приложений.

Параметры

-Api

Задает параметры приложения, реализующего веб-API.

Свойства параметров

Тип:ApiApplication
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ApplicationId

Указывает идентификатор приложения в Microsoft Entra ID.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:ObjectId (идентификатор объекта)

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-AppRoles

Коллекция ролей приложения, которые может объявить приложение.

Эти роли могут назначаться пользователям, группам или субъектам-службам.

Свойства параметров

Тип:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DisplayName

Указывает отображаемое имя.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-GroupMembershipClaims

Настраивает утверждение групп, выданное пользователем или маркером доступа OAuth 2.0, которое ожидает приложение.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-IdentifierUris

Задает универсальные идентификаторы ресурсов (URI).

Свойства параметров

Тип:

System.Collections.Generic.List`1[System.String]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-InformationalUrl

Основные сведения о профиле приложения, такие как маркетинг приложения, поддержка, условия обслуживания и URL-адреса заявления о конфиденциальности.

Условия обслуживания и заявление о конфиденциальности отображаются в окне запроса согласия пользователя.

Свойства параметров

Тип:InformationalUrl
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-IsDeviceOnlyAuthSupported

Указывает, поддерживает ли приложение проверку подлинности с помощью маркера устройства.

Свойства параметров

Тип:System.Boolean
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-IsFallbackPublicClient

Указывает резервный тип приложения как общедоступный клиент, например установленное приложение, запущенное на мобильном устройстве.

Значение по умолчанию означает false , что резервный тип приложения является конфиденциальным клиентом, например веб-приложением.

Существуют определенные сценарии, в которых Microsoft Entra ID не удается определить тип клиентского приложения (например, поток ROPC, в котором он настроен без указания URI перенаправления).

В таких случаях Microsoft Entra ID интерпретирует тип приложения на основе значения этого свойства.

Свойства параметров

Тип:System.Boolean
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-KeyCredentials

Задает ключевые учетные данные.

Свойства параметров

Тип:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-OptionalClaims

Разработчики приложений могут настроить необязательные утверждения в приложениях Microsoft Entra ID, чтобы указать утверждения, которые они хотят в токенах, отправленных в приложение службой маркеров безопасности Microsoft.

Свойства параметров

Тип:OptionalClaims
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ParentalControlSettings

Указывает параметры родительского контроля для приложения.

Свойства параметров

Тип:ParentalControlSettings
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PasswordCredentials

Указывает учетные данные пароля.

Свойства параметров

Тип:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PublicClient

Указывает, является ли это приложение общедоступным клиентом (например, установленным приложением, запущенным на мобильном устройстве). По умолчанию — false.

Свойства параметров

Тип:PublicClientApplication
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RequiredResourceAccess

Указывает ресурсы, к которым требуется доступ к этому приложению, и набор областей разрешений OAuth и ролей приложений, необходимых для каждого из этих ресурсов.

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

Свойства параметров

Тип:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SignInAudience

Указывает, какие учетные записи Майкрософт поддерживаются для текущего приложения.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Tags

Настраиваемые строки, которые можно использовать для классификации и определения приложения.

Свойства параметров

Тип:

System.Collections.Generic.List`1[System.String]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-TokenEncryptionKeyId

Задает значение открытого ключа keyId из коллекции keyCredentials.

После настройки Microsoft Entra ID шифрует все выдаваемые маркеры с помощью ключа, на который указывает это свойство.

Код приложения, получающий зашифрованный маркер, должен использовать соответствующий закрытый ключ для расшифровки маркера, прежде чем его можно будет применить для пользователя, выполнившего вход.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Web

Указывает параметры для веб-приложения.

Свойства параметров

Тип:WebApplication
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

Boolean

Microsoft.Open.MSGraph.Model.ApiApplication

Microsoft.Open.MSGraph.Model.InformationalUrl

Microsoft.Open.MSGraph.Model.OptionalClaims

Microsoft.Open.MSGraph.Model.ParentalControlSettings

Microsoft.Open.MSGraph.Model.PublicClientApplication

Microsoft.Open.MSGraph.Model.WebApplication

String

System.Collections.Generic.List`1

System.Collections.Generic.List`1

System.Collections.Generic.List`1

System.Collections.Generic.List`1

System.Collections.Generic.List`1

System.Collections.Generic.List`1

System.Nullable`1