Update-AzADServicePrincipal

Module:

Az.Resources Module

Updates entity in service principal

Syntax

SpObjectIdWithDisplayNameParameterSet (Default)

Update-AzADServicePrincipal
    -ObjectId <String>
    [-KeyCredential <IMicrosoftGraphKeyCredential[]>]
    [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>]
    [-IdentifierUri <String[]>]
    [-Homepage <String>]
    [-AccountEnabled]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-AlternativeName <String[]>]
    [-AppDescription <String>]
    [-AppOwnerOrganizationId <String>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignmentRequired]
    [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]
    [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-Endpoint <IMicrosoftGraphEndpoint[]>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-LoginUrl <String>]
    [-LogoutUrl <String>]
    [-Note <String>]
    [-NotificationEmailAddress <String[]>]
    [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
    [-PreferredSingleSignOnMode <String>]
    [-PreferredTokenSigningKeyThumbprint <String>]
    [-ReplyUrl <String[]>]
    [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
    [-ServicePrincipalType <String>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SpApplicationIdWithDisplayNameParameterSet

Update-AzADServicePrincipal
    -ApplicationId <Guid>
    [-KeyCredential <IMicrosoftGraphKeyCredential[]>]
    [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>]
    [-IdentifierUri <String[]>]
    [-Homepage <String>]
    [-AccountEnabled]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-AlternativeName <String[]>]
    [-AppDescription <String>]
    [-AppOwnerOrganizationId <String>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignmentRequired]
    [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]
    [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-Endpoint <IMicrosoftGraphEndpoint[]>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-LoginUrl <String>]
    [-LogoutUrl <String>]
    [-Note <String>]
    [-NotificationEmailAddress <String[]>]
    [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
    [-PreferredSingleSignOnMode <String>]
    [-PreferredTokenSigningKeyThumbprint <String>]
    [-ReplyUrl <String[]>]
    [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
    [-ServicePrincipalType <String>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectWithDisplayNameParameterSet

Update-AzADServicePrincipal
    -InputObject <IMicrosoftGraphServicePrincipal>
    [-KeyCredential <IMicrosoftGraphKeyCredential[]>]
    [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>]
    [-IdentifierUri <String[]>]
    [-Homepage <String>]
    [-AccountEnabled]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-AlternativeName <String[]>]
    [-AppDescription <String>]
    [-AppOwnerOrganizationId <String>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignmentRequired]
    [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]
    [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-Endpoint <IMicrosoftGraphEndpoint[]>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-LoginUrl <String>]
    [-LogoutUrl <String>]
    [-Note <String>]
    [-NotificationEmailAddress <String[]>]
    [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
    [-PreferredSingleSignOnMode <String>]
    [-PreferredTokenSigningKeyThumbprint <String>]
    [-ReplyUrl <String[]>]
    [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
    [-ServicePrincipalType <String>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SPNWithDisplayNameParameterSet

Update-AzADServicePrincipal
    -ServicePrincipalName <String>
    [-KeyCredential <IMicrosoftGraphKeyCredential[]>]
    [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>]
    [-IdentifierUri <String[]>]
    [-Homepage <String>]
    [-AccountEnabled]
    [-AddIn <IMicrosoftGraphAddIn[]>]
    [-AlternativeName <String[]>]
    [-AppDescription <String>]
    [-AppOwnerOrganizationId <String>]
    [-AppRole <IMicrosoftGraphAppRole[]>]
    [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]
    [-AppRoleAssignmentRequired]
    [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]
    [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisabledByMicrosoftStatus <String>]
    [-DisplayName <String>]
    [-Endpoint <IMicrosoftGraphEndpoint[]>]
    [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
    [-Info <IMicrosoftGraphInformationalUrl>]
    [-LoginUrl <String>]
    [-LogoutUrl <String>]
    [-Note <String>]
    [-NotificationEmailAddress <String[]>]
    [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
    [-PreferredSingleSignOnMode <String>]
    [-PreferredTokenSigningKeyThumbprint <String>]
    [-ReplyUrl <String[]>]
    [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
    [-ServicePrincipalType <String>]
    [-Tag <String[]>]
    [-TokenEncryptionKeyId <String>]
    [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
    [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
    [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Updates entity in service principal

Examples

Example 1: Update service principal and associated application by display name

Update-AzADServicePrincipal -DisplayName $name -IdentifierUri $uri

Update service principal and associated application by display name, 'IdentifierUri', 'PasswordCredential', 'KeyCredential' will be assigned to application

Example 2: Update service principal by pipeline input

Get-AzADServicePrincipal -ObjectId $id | Update-AzADServicePrincipal -Note $note

Update service principal and associated application by display name, 'IdentifierUri', 'PasswordCredential', 'KeyCredential' will be assigned to application

Parameters

-AccountEnabled

true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in).

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

-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 Microsoft 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

-AlternativeName

Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. 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

-AppDescription

The description exposed by the associated 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

-ApplicationId

The unique identifier for the associated application (its appId property).

Parameter properties

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

Parameter sets

SpApplicationIdWithDisplayNameParameterSet

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

-AppOwnerOrganizationId

Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le).

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 roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. 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

-AppRoleAssignedTo

App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. To construct, see NOTES section for APPROLEASSIGNEDTO properties and create a hash table.

Parameter properties

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

-AppRoleAssignment

App role assignment for another app or service, granted to this service principal. Supports $expand. To construct, see NOTES section for APPROLEASSIGNMENT properties and create a hash table.

Parameter properties

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

-AppRoleAssignmentRequired

Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).

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

-ClaimsMappingPolicy

The claimsMappingPolicies assigned to this service principal. Supports $expand. To construct, see NOTES section for CLAIMSMAPPINGPOLICY properties and create a hash table.

Parameter properties

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

-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

-DelegatedPermissionClassification

The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. To construct, see NOTES section for DELEGATEDPERMISSIONCLASSIFICATION properties and create a hash table.

Parameter properties

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

-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

Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. 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 service principal. 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

-Endpoint

Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. To construct, see NOTES section for ENDPOINT properties and create a hash table.

Parameter properties

Type:	IMicrosoftGraphEndpoint[]
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 or landing page 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

-HomeRealmDiscoveryPolicy

The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. 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

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

service principal object

Parameter properties

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

Parameter sets

InputObjectWithDisplayNameParameterSet

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

-KeyCredential

The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). To construct, see NOTES section for KEYCREDENTIALS properties and create a hash table.

Parameter properties

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

-LoginUrl

Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.

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

-LogoutUrl

Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.

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

Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.

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

-NotificationEmailAddress

Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery 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

-Oauth2PermissionScope

The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. To construct, see NOTES section for OAUTH2PERMISSIONSCOPE properties and create a hash table.

Parameter properties

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

Parameter properties

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

Parameter sets

SpObjectIdWithDisplayNameParameterSet

Position:	Named
Mandatory:	True
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

-PasswordCredential

The collection of password credentials associated with the application. Not nullable. To construct, see NOTES section for PASSWORDCREDENTIALS properties and create a hash table.

Parameter properties

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

-PreferredSingleSignOnMode

Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc.

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

-PreferredTokenSigningKeyThumbprint

Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions.

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 URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated 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

-SamlSingleSignOnSetting

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

Parameter properties

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

-ServicePrincipalName

Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith).

Parameter properties

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

Parameter sets

SPNWithDisplayNameParameterSet

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

-ServicePrincipalType

Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity.

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 service principal. 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 issues tokens for this application encrypted using the key specified by this property. 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

The tokenIssuancePolicies assigned to this service principal. Supports $expand. 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 service principal. 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

-TransitiveMemberOf

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

Parameter properties

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

IMicrosoftGraphServicePrincipal

Outputs

Boolean

Notes

ALIASES

Set-AzADServicePrincipal