New-AzADServicePrincipal
Adds new entity to servicePrincipals
Syntax
SimpleParameterSet (Default)
New-AzADServicePrincipal
[-DisplayName <String>]
[-Role <String>]
[-Scope <String>]
[-Homepage <String>]
[-ReplyUrl <String[]>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-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>]
[-Endpoint <IMicrosoftGraphEndpoint[]>]
[-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
[-Info <IMicrosoftGraphInformationalUrl>]
[-LoginUrl <String>]
[-LogoutUrl <String>]
[-Note <String>]
[-NotificationEmailAddress <String[]>]
[-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
[-PreferredSingleSignOnMode <String>]
[-PreferredTokenSigningKeyThumbprint <String>]
[-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
[-ServicePrincipalName <String[]>]
[-ServicePrincipalType <String>]
[-Tag <String[]>]
[-TokenEncryptionKeyId <String>]
[-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
[-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DisplayNameWithPasswordCredentialParameterSet
New-AzADServicePrincipal
-DisplayName <String>
-PasswordCredential <IMicrosoftGraphPasswordCredential[]>
[-Role <String>]
[-Scope <String>]
[-Homepage <String>]
[-ReplyUrl <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>]
[-Endpoint <IMicrosoftGraphEndpoint[]>]
[-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
[-Info <IMicrosoftGraphInformationalUrl>]
[-LoginUrl <String>]
[-LogoutUrl <String>]
[-Note <String>]
[-NotificationEmailAddress <String[]>]
[-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
[-PreferredSingleSignOnMode <String>]
[-PreferredTokenSigningKeyThumbprint <String>]
[-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
[-ServicePrincipalName <String[]>]
[-ServicePrincipalType <String>]
[-Tag <String[]>]
[-TokenEncryptionKeyId <String>]
[-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
[-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DisplayNameWithKeyCredentialParameterSet
New-AzADServicePrincipal
-DisplayName <String>
-KeyCredential <IMicrosoftGraphKeyCredential[]>
[-Role <String>]
[-Scope <String>]
[-Homepage <String>]
[-ReplyUrl <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>]
[-Endpoint <IMicrosoftGraphEndpoint[]>]
[-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
[-Info <IMicrosoftGraphInformationalUrl>]
[-LoginUrl <String>]
[-LogoutUrl <String>]
[-Note <String>]
[-NotificationEmailAddress <String[]>]
[-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
[-PreferredSingleSignOnMode <String>]
[-PreferredTokenSigningKeyThumbprint <String>]
[-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
[-ServicePrincipalName <String[]>]
[-ServicePrincipalType <String>]
[-Tag <String[]>]
[-TokenEncryptionKeyId <String>]
[-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
[-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DisplayNameWithKeyPlainParameterSet
New-AzADServicePrincipal
-DisplayName <String>
-CertValue <String>
[-Role <String>]
[-Scope <String>]
[-Homepage <String>]
[-ReplyUrl <String[]>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-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>]
[-Endpoint <IMicrosoftGraphEndpoint[]>]
[-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
[-Info <IMicrosoftGraphInformationalUrl>]
[-LoginUrl <String>]
[-LogoutUrl <String>]
[-Note <String>]
[-NotificationEmailAddress <String[]>]
[-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
[-PreferredSingleSignOnMode <String>]
[-PreferredTokenSigningKeyThumbprint <String>]
[-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
[-ServicePrincipalName <String[]>]
[-ServicePrincipalType <String>]
[-Tag <String[]>]
[-TokenEncryptionKeyId <String>]
[-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
[-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ApplicationObjectParameterSet
New-AzADServicePrincipal
-ApplicationObject <IMicrosoftGraphApplication>
[-Role <String>]
[-Scope <String>]
[-Homepage <String>]
[-ReplyUrl <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>]
[-Endpoint <IMicrosoftGraphEndpoint[]>]
[-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
[-Info <IMicrosoftGraphInformationalUrl>]
[-LoginUrl <String>]
[-LogoutUrl <String>]
[-Note <String>]
[-NotificationEmailAddress <String[]>]
[-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
[-PreferredSingleSignOnMode <String>]
[-PreferredTokenSigningKeyThumbprint <String>]
[-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
[-ServicePrincipalName <String[]>]
[-ServicePrincipalType <String>]
[-Tag <String[]>]
[-TokenEncryptionKeyId <String>]
[-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
[-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ApplicationIdParameterSet
New-AzADServicePrincipal
[-Role <String>]
[-Scope <String>]
[-Homepage <String>]
[-ReplyUrl <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>]
[-Endpoint <IMicrosoftGraphEndpoint[]>]
[-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]
[-Info <IMicrosoftGraphInformationalUrl>]
[-LoginUrl <String>]
[-LogoutUrl <String>]
[-Note <String>]
[-NotificationEmailAddress <String[]>]
[-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]
[-PreferredSingleSignOnMode <String>]
[-PreferredTokenSigningKeyThumbprint <String>]
[-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]
[-ServicePrincipalName <String[]>]
[-ServicePrincipalType <String>]
[-Tag <String[]>]
[-TokenEncryptionKeyId <String>]
[-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]
[-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-ApplicationId <Guid>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Adds new entity to servicePrincipals
Examples
Example 1: Create service principal without application or display name
New-AzADServicePrincipal
Create application with display name "azure-powershell-MM-dd-yyyy-HH-mm-ss" and new service principal associate with it
Example 2: Create service principal with existing application
New-AzADServicePrincipal -ApplicationId $appid
Create service principal with existing application
Example 3: Create application with display name and associated new service principal with it
New-AzADServicePrincipal -DisplayName $name
Create application with display name and associated new service principal with it
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
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
ApplicationIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ApplicationObject
The application object, could be used as pipeline input.
Parameter properties
Parameter sets
ApplicationObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True 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
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
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
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
-CertValue
The value of the 'asymmetric' credential type.
It represents the base 64 encoded certificate.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DisplayNameWithKeyPlainParameterSet
Position: Named Mandatory: True 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
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: 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
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
SimpleParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EndDate
The effective end date of the credential usage.
The default end date value is one year from today.
For an 'asymmetric' type credential, this must be set to on or before the date that the X509 certificate is valid.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SimpleParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DisplayNameWithKeyPlainParameterSet
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
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
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
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyCredential
key credentials associated with the service principal.
Parameter properties
Parameter sets
DisplayNameWithKeyCredentialParameterSet
Position: Named Mandatory: True 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
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PasswordCredential
Password credentials associated with the service principal.
Parameter properties
Parameter sets
DisplayNameWithPasswordCredentialParameterSet
Position: Named Mandatory: True 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
-Role
The role that the service principal has over the scope.
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
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Scope
The scope that the service principal has permissions for.
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
-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
Parameter sets
(All)
Position: Named Mandatory: False 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
-StartDate
The effective start date of the credential usage.
The default start date value is today.
For an 'asymmetric' type credential, this must be set to on or after the date that the X509 certificate is valid from.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SimpleParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DisplayNameWithKeyPlainParameterSet
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
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
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
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 .
Outputs
