< Back

Set-AzureRmADServicePrincipal

Tue Jan 29, 2019 10:06 pm

NAME Set-AzureRmADServicePrincipal



SYNOPSIS

Updates an existing azure active directory service principal.





SYNTAX

Set-AzureRmADServicePrincipal [-DefaultProfile <IAzureContextContainer>] -DisplayName <String> -ObjectId <String> [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-AzureRmADServicePrincipal [-DefaultProfile <IAzureContextContainer>] -DisplayName <String> -ServicePrincipalName <String> [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

Updates an existing azure active directory service principal. To update the credentials associated with this service principal, please use

New-AzureRmADSpCredential cmdlet. To update the properties associated with the underlying application, please use Set-AzureRmADApplication cmdlet.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DisplayName <String>

New display name for the service principal.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ObjectId <String>

The object id of the service principal to update.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServicePrincipalName <String>

The SPN of service principal to update.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]





Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS



NOTES









Example 1



Set-AzureRmADServicePrincipal -ObjectId 784136ca-3ae2-4fdd-a388-89d793e7c780 -DisplayName "UpdatedNameForSp"



Updates the display name for the service principal with specified object id.





Example 2



Set-AzureRmADServicePrincipal -ServicePrincipalName "http://MyApp1" -DisplayName "UpdatedNameforSp"



Updates the display name for the service principal with specified service principal name.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... eprincipal

New-AzureRmADServicePrincipal

Get-AzureRmADServicePrincipal

Remove-AzureRmADServicePrincipal

Set-AzureRmADApplication

New-AzureRmADSpCredential

Remove-AzureRmADSpCredential