Set-AzureADServicePrincipal
Updates a service principal.
Syntax
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 2e0d8ca7-57d1-4a87-9c2a-b3638a4cadbf -AccountEnabled $FalseThis command disables the account of the specified service principal.
Parameters
-AccountEnabled
Indicates whether the account is enabled.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AlternativeNames
The alternative names for this service principal
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AppId
Specifies the application ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AppRoleAssignmentRequired
Indicates whether an application role assignment is required.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Specifies the display name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorUrl
Specifies the error URL.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Homepage
Specifies the home page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyCredentials
Specifies key credentials.
| Type: | List<T>[Microsoft.Open.AzureAD.Model.KeyCredential] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogoutUrl
Specifies the logout URL.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ObjectId
Specifies the ID of a service principal in Azure AD.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PasswordCredentials
Specifies password credentials.
| Type: | List<T>[Microsoft.Open.AzureAD.Model.PasswordCredential] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublisherName
Specifies the publisher name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SamlMetadataUrl
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServicePrincipalNames
Specifies service principal names.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServicePrincipalType
The service principal type
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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}
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |