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:使用 Tags 参数更新应用程序
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
指定实现 Web API 的应用程序的设置。
参数属性
| 类型: | ApiApplication |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ApplicationId
指定Microsoft Entra ID中应用程序的 ID。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 对象标识符 (ObjectId) |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-AppRoles
应用程序可能声明的应用程序角色的集合。
可将这些角色分配给用户、组或服务主体。
参数属性
| 类型: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DisplayName
指定显示名称。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-GroupMembershipClaims
配置应用程序所需的用户或 OAuth 2.0 访问令牌中颁发的组声明。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IdentifierUris
指定标识符统一资源标识符(URI)。
参数属性
| 类型: | System.Collections.Generic.List`1[System.String] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-InformationalUrl
应用程序的基本配置文件信息,例如应用的营销、支持、服务条款和隐私声明 URL。
服务条款和隐私声明通过用户同意体验展示给用户。
参数属性
| 类型: | InformationalUrl |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IsDeviceOnlyAuthSupported
指定应用程序是否支持使用设备令牌进行身份验证。
参数属性
| 类型: | System.Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IsFallbackPublicClient
将回退应用程序类型指定为公共客户端,例如在移动设备上运行的已安装应用程序。
默认值 false 表示回退应用程序类型是机密客户端,例如 Web 应用。
在某些情况下,Microsoft Entra ID无法确定客户端应用程序类型(例如,未指定重定向 URI 的情况下配置的 ROPC 流)。
在这些情况下,Microsoft Entra ID根据此属性的值解释应用程序类型。
参数属性
| 类型: | System.Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-KeyCredentials
指定密钥凭据。
参数属性
| 类型: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-OptionalClaims
应用程序开发人员可以在其Microsoft Entra ID应用中配置可选声明,以指定要在令牌中由Microsoft安全令牌服务发送到其应用程序的声明。
参数属性
| 类型: | OptionalClaims |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ParentalControlSettings
指定应用程序的家长控制设置。
参数属性
| 类型: | ParentalControlSettings |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PasswordCredentials
指定密码凭据。
参数属性
| 类型: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PublicClient
指定此应用程序是否为公共客户端 (,例如在移动设备) 上运行的已安装应用程序。 默认值为 false。
参数属性
| 类型: | PublicClientApplication |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RequiredResourceAccess
指定此应用程序需要访问的资源以及它在每个资源下所需的 OAuth 权限范围和应用程序角色集。
此所需资源访问的预配置会驱动许可体验。
参数属性
| 类型: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SignInAudience
指定当前应用程序支持的 Microsoft 帐户。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Tags
可用于分类和标识应用程序的自定义字符串。
参数属性
| 类型: | System.Collections.Generic.List`1[System.String] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TokenEncryptionKeyId
指定 keyCredentials 集合中的公共密钥的 keyId。
配置后,Microsoft Entra ID使用此属性指向的密钥加密它发出的所有令牌。
接收加密令牌的应用程序代码必须先使用匹配的私钥来解密该令牌,然后才能将该令牌用于登录用户。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Web
指定 Web 应用程序的设置。
参数属性
| 类型: | WebApplication |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。