Edit

Share via


Update-AzADApplication

Updates entity in applications

Syntax

ApplicationObjectIdWithUpdateParamsParameterSet (Default)

Update-AzADApplication
    -ObjectId <String>
    [-HomePage <String>]
    [-ReplyUrl <String[]>]
    [-AvailableToOtherTenants <Boolean>]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-Api <IMicrosoftGraphApiApplication>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-ApplicationTemplateId <String>]
    [-CreatedOnBehalfOfDeletedDateTime <DateTime>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-GroupMembershipClaim <String>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-IdentifierUri <String[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-IsDeviceOnlyAuthSupported]
    [-IsFallbackPublicClient]
    [-LogoInputFile <String>]
    [-Note <String>]
    [-Oauth2RequirePostResponse]
    [-OptionalClaim <IMicrosoftGraphOptionalClaims>]
    [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]
    [-PublicClientRedirectUri <String[]>]
    [-RequestedAccessTokenVersion <Int32>]
    [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]
    [-ServiceManagementReference <String>]
    [-SignInAudience <String>]
    [-SPARedirectUri <String[]>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-Web <IMicrosoftGraphWebApplication>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ApplicationIdWithUpdateParamsParameterSet

Update-AzADApplication
    -ApplicationId <Guid>
    [-HomePage <String>]
    [-ReplyUrl <String[]>]
    [-AvailableToOtherTenants <Boolean>]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-Api <IMicrosoftGraphApiApplication>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-ApplicationTemplateId <String>]
    [-CreatedOnBehalfOfDeletedDateTime <DateTime>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-GroupMembershipClaim <String>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-IdentifierUri <String[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-IsDeviceOnlyAuthSupported]
    [-IsFallbackPublicClient]
    [-LogoInputFile <String>]
    [-Note <String>]
    [-Oauth2RequirePostResponse]
    [-OptionalClaim <IMicrosoftGraphOptionalClaims>]
    [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]
    [-PublicClientRedirectUri <String[]>]
    [-RequestedAccessTokenVersion <Int32>]
    [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]
    [-ServiceManagementReference <String>]
    [-SignInAudience <String>]
    [-SPARedirectUri <String[]>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-Web <IMicrosoftGraphWebApplication>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectWithUpdateParamsParameterSet

Update-AzADApplication
    -InputObject <IMicrosoftGraphApplication>
    [-HomePage <String>]
    [-ReplyUrl <String[]>]
    [-AvailableToOtherTenants <Boolean>]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-Api <IMicrosoftGraphApiApplication>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-ApplicationTemplateId <String>]
    [-CreatedOnBehalfOfDeletedDateTime <DateTime>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-GroupMembershipClaim <String>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-IdentifierUri <String[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-IsDeviceOnlyAuthSupported]
    [-IsFallbackPublicClient]
    [-LogoInputFile <String>]
    [-Note <String>]
    [-Oauth2RequirePostResponse]
    [-OptionalClaim <IMicrosoftGraphOptionalClaims>]
    [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]
    [-PublicClientRedirectUri <String[]>]
    [-RequestedAccessTokenVersion <Int32>]
    [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]
    [-ServiceManagementReference <String>]
    [-SignInAudience <String>]
    [-SPARedirectUri <String[]>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-Web <IMicrosoftGraphWebApplication>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Updates entity in applications

Examples

Example 1: Update application by display name

Update-AzADApplication -DisplayName $name -HomePage $homepage

Update application by display name

Example 2: Update application by pipeline input

Get-AzADApplication -ObjectId $id | Update-AzADApplication -ReplyUrl $replyurl

Update application by pipeline input

Parameters

-AddIn

Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. To construct, see NOTES section for ADDIN properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphAddIn[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Api

apiApplication To construct, see NOTES section for API properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphApiApplication
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationId

key: application id

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppId

Parameter sets

ApplicationIdWithUpdateParamsParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationTemplateId

Unique identifier of the applicationTemplate.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AppRole

The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. To construct, see NOTES section for APPROLE properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphAppRole[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailableToOtherTenants

The value specifying whether the application is a single tenant or a multi-tenant. Is equivalent to '-SignInAudience AzureADMultipleOrgs' when switch is on

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreatedOnBehalfOfDeletedDateTime

.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeletedDateTime

.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisabledByMicrosoftStatus

Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT).

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

The display name for the application. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GroupMembershipClaim

Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of).

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HomePage

home page url for web

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:WebHomePageUrl

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HomeRealmDiscoveryPolicy

. To construct, see NOTES section for HOMEREALMDISCOVERYPOLICY properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphHomeRealmDiscoveryPolicy[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IdentifierUri

The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith).

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IdentifierUris

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Info

informationalUrl To construct, see NOTES section for INFO properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphInformationalUrl
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

key: application object

Parameter properties

Type:IMicrosoftGraphApplication
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObjectWithUpdateParamsParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IsDeviceOnlyAuthSupported

Specifies whether this application supports device authentication without a user. The default is false.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsFallbackPublicClient

Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogoInputFile

Input File for Logo (The main logo for the application. Not nullable.)

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Note

Notes relevant for the management of the application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Oauth2RequirePostResponse

.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ObjectId

key: id of application

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

ApplicationObjectIdWithUpdateParamsParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OptionalClaim

optionalClaims To construct, see NOTES section for OPTIONALCLAIM properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphOptionalClaims
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentalControlSetting

parentalControlSettings To construct, see NOTES section for PARENTALCONTROLSETTING properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphParentalControlSettings
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublicClientRedirectUri

Updates entity in applications

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplyUrl

The application reply Urls.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:ReplyUrls, WebRedirectUri

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestedAccessTokenVersion

Updates entity in applications

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequiredResourceAccess

Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). To construct, see NOTES section for REQUIREDRESOURCEACCESS properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphRequiredResourceAccess[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceManagementReference

References application or service contact information from a Service or Asset Management database. Nullable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SignInAudience

Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT).

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SPARedirectUri

Updates entity in applications

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tag

Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith).

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TokenEncryptionKeyId

Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TokenIssuancePolicy

. To construct, see NOTES section for TOKENISSUANCEPOLICY properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphTokenIssuancePolicy[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TokenLifetimePolicy

The tokenLifetimePolicies assigned to this application. Supports $expand. To construct, see NOTES section for TOKENLIFETIMEPOLICY properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphTokenLifetimePolicy[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Web

webApplication To construct, see NOTES section for WEB properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphWebApplication
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IMicrosoftGraphApplication

Outputs

Boolean

Notes

ALIASES

Set-AzADApplication