New-EntraServicePrincipalPasswordCredential

  • Reference
Module:
Microsoft.Graph.Entra

Creates a password credential for a service principal.

Syntax

New-EntraServicePrincipalPasswordCredential
    -ObjectId <String>
   [-EndDate <DateTime>]
    [-StartDate <DateTime>] 
   [<CommonParameters>]

Description

The New-EntraServicePrincipalPasswordCredential cmdlet creates a password credential for a service principal in Microsoft Entra ID.

Examples

Example 1: Create a password credential with StartDate

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$ServicePrincipal = Get-EntraServicePrincipal -Filter "DisplayName eq '<service-principal-display-name>'"
$Params = @{
    ObjectId = $ServicePrincipal.ObjectId
    StartDate = '2024-04-21T14:14:14Z'
}
New-EntraServicePrincipalPasswordCredential @Params

secretText          : A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
@odata.type         : #microsoft.graph.servicePrincipal
endDateTime         : 08-08-2026 10:30:00
hint                : LY.
customKeyIdentifier :
startDateTime       : 08-08-2024 14:14:14
keyId               : aaaaaaaa-0b0b-1c1c-2d2d-333333333333
@odata.context      : https://graph.microsoft.com/beta/$metadata#servicePrincipals('00001111-aaaa-2222-bbbb-3333cccc4444')/addPassword
displayName         :
StartDate           : 08-08-2024 14:14:14
EndDate             : 08-08-2026 10:30:00

This example demonstrates how to create a password credential with StartDate for a service principal in Microsoft Entra ID.

  • -ObjectId parameter specifies the ID of a service principal.
  • -StarteDate parameter specifies the date and time at which the password becomes valid.

Example 2: Create a password credential with EndtDate

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$ServicePrincipal = Get-EntraServicePrincipal -Filter "DisplayName eq '<service-principal-display-name>'"
$Params = @{
    ObjectId = $ServicePrincipal.ObjectId
    EndDate = '2030-03-21T14:14:14Z'
}
New-EntraServicePrincipalPasswordCredential @Params

secretText          : A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
@odata.type         : #microsoft.graph.servicePrincipal
endDateTime         : 08-08-2026 10:30:00
hint                : LY.
customKeyIdentifier :
startDateTime       : 08-08-2024 14:14:14
keyId               : bbbbbbbb-1c1c-2d2d-3e3e-444444444444
@odata.context      : https://graph.microsoft.com/beta/$metadata#servicePrincipals('00001111-aaaa-2222-bbbb-3333cccc4444')/addPassword
displayName         :
StartDate           : 08-08-2024 14:14:14
EndDate             : 08-08-2026 10:30:00

This example demonstrates how to create a password credential with EndDate for a service principal in Microsoft Entra ID.

  • -ObjectId parameter specifies the ID of a service principal.
  • -EndDate parameter specifies the date and time at which the password expires represented using ISO 8601 format and is always in UTC time.

Parameters

-EndDate

The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2024 is 2024-01-01T00:00:00Z.

Type:System.DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

Specifies the ID of the service principal.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StartDate

The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2024 is 2024-01-01T00:00:00Z.

Type:System.DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False