Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzureADServicePrincipal
- Module:
- AzureAD Module
Updates a service principal.
Syntax
Default (Default)
Set-AzureADServicePrincipal
-ObjectId <String>
[-AccountEnabled <String>]
[-AlternativeNames <System.Collections.Generic.List`1[System.String]>]
[-AppId <String>]
[-AppRoleAssignmentRequired <Boolean>]
[-DisplayName <String>]
[-ErrorUrl <String>]
[-Homepage <String>]
[-KeyCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]>]
[-LogoutUrl <String>]
[-PasswordCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]>]
[-PublisherName <String>]
[-ReplyUrls <System.Collections.Generic.List`1[System.String]>]
[-SamlMetadataUrl <String>]
[-ServicePrincipalNames <System.Collections.Generic.List`1[System.String]>]
[-ServicePrincipalType <String>]
[-Tags <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>]
Description
The Set-AzureADServicePrincipal cmdlet updates a service principal in Azure Active Directory (Azure AD).
Examples
Example 1: Disable the account of a service principal
PS C:\> Set-AzureADServicePrincipal -ObjectId aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb -AccountEnabled $False
This command disables the account of the specified service principal.
Parameters
-AccountEnabled
Indicates whether the account is enabled.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AlternativeNames
The alternative names for this service principal
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AppId
Specifies the application ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AppRoleAssignmentRequired
Indicates whether an application role assignment is required.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisplayName
Specifies the display name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ErrorUrl
Specifies the error URL.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Homepage
Specifies the home page.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyCredentials
Specifies key credentials.
Parameter properties
| Type: | List<T>[Microsoft.Open.AzureAD.Model.KeyCredential] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LogoutUrl
Specifies the logout URL.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ObjectId
Specifies the ID of a service principal in Azure AD.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PasswordCredentials
Specifies password credentials.
Parameter properties
| Type: | List<T>[Microsoft.Open.AzureAD.Model.PasswordCredential] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublisherName
Specifies the publisher name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ReplyUrls
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.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SamlMetadataUrl
@{Text=}
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServicePrincipalNames
Specifies service principal names.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServicePrincipalType
The service principal type
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tags
Specifies an array of tags. Note that if you intend for this service principal to show up in the All Applications list in the admin portal, you need to set this value to {WindowsAzureActiveDirectoryIntegratedApp}
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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.
Notes
See the migration guide for Set-AzureADServicePrincipal to the Microsoft Graph PowerShell.
Related Links
Feedback
Was this page helpful?