Set-EntraServicePrincipal

Met à jour un principal de service.

Syntaxe

Default (Par défaut)

Set-EntraServicePrincipal

    -ServicePrincipalId <String>
    [-KeyCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]>]
    [-Homepage <String>]
    [-AppId <String>]
    [-LogoutUrl <String>]
    [-ServicePrincipalType <String>]
    [-AlternativeNames <System.Collections.Generic.List`1[System.String]>]
    [-PasswordCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]>]
    [-PreferredSingleSignOnMode <String>]
    [-Tags <System.Collections.Generic.List`1[System.String]>]
    [-AccountEnabled <String>]
    [-ServicePrincipalNames <System.Collections.Generic.List`1[System.String]>]
    [-AppRoleAssignmentRequired <Boolean>]
    [-DisplayName <String>]
    [-ReplyUrls <System.Collections.Generic.List`1[System.String]>]
    [<CommonParameters>]

Description

L’applet Set-EntraServicePrincipal de commande met à jour un principal de service dans Microsoft Entra ID.

Exemples

Exemple 1 : Désactiver le compte d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -AccountEnabled $false

Cet exemple montre comment mettre à jour AccountEnabled un principal de service dans Microsoft Entra ID.

  • -ServicePrincipalId spécifie l’ID d’un principal de service.
  • -AccountEnabled spécifie si le compte est activé.

Exemple 2 : Mettre à jour la page d’accueil d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
$homePage = 'https://*.e-days.com/SSO/SAML2/SP/AssertionConsumer.aspx?metadata=e-days|ISV9.2|primary|z'
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -Homepage $homePage

Cet exemple montre comment mettre à jour et page AppId d’accueil d’un principal de service dans Microsoft Entra ID.

  • -ServicePrincipalId spécifie l’ID d’un principal de service.
  • -AppId spécifie l’ID d’application.
  • -Homepage spécifie la page d’accueil ou la page d’accueil de l’application.

Exemple 3 : Mettre à jour les alternativeNames et DisplayName d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -AlternativeNames 'Helpdesk Application Global' -DisplayName 'NewName'

Cet exemple montre comment mettre à jour AlternativeNames et DisplayName d’un principal de service dans Microsoft Entra ID.

  • -ServicePrincipalId spécifie l’ID d’un principal de service.

Exemple 4 : Mettre à jour LogoutUrl et ReplyUrls d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
$logoutUrl = 'https://securescore.office.com/SignOut'
$replyUrls = 'https://admin.contoso.com'
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -LogoutUrl $logoutUrl -ReplyUrls $replyUrls

Cet exemple montre comment mettre à jour LogoutUrl et ReplyUrls d’un principal de service dans Microsoft Entra ID.

  • -ServicePrincipalId spécifie l’ID d’un principal de service.
  • -LogoutUrl spécifie l’URL de déconnexion.
  • -ReplyUrls spécifie les URL auxquelles les jetons utilisateur sont envoyés pour la connexion avec l’application associée.

Exemple 5 : Mettre à jour ServicePrincipalType et AppRoleAssignmentRequired d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -ServicePrincipalType 'Application' -AppRoleAssignmentRequired $True

Cet exemple montre comment mettre à jour ServicePrincipalType et AppRoleAssignmentRequired utiliser un principal de service dans Microsoft Entra ID.

  • -ServicePrincipalId spécifie l’ID d’un principal de service.
  • -ServicePrincipalType spécifie le type de principal de service.
  • -AppRoleAssignmentRequired spécifie si une attribution de rôle d’application est requise.

Exemple 6 : Mettre à jour keyCredentials d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
$creds = New-Object Microsoft.Open.AzureAD.Model.KeyCredential
$creds.CustomKeyIdentifier = [System.Text.Encoding]::UTF8.GetBytes('Test')
$startdate = Get-Date -Year 2024 -Month 10 -Day 10
$creds.StartDate = $startdate
$creds.Type = 'Symmetric'
$creds.Usage = 'Sign'
$creds.Value = [System.Text.Encoding]::UTF8.GetBytes('A')
$creds.EndDate = Get-Date -Year 2025 -Month 12 -Day 20
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -KeyCredentials $creds

Cet exemple montre comment mettre à jour keyCredentials d’un principal de service dans Microsoft Entra ID.

Utilisez les New-EntraServicePrincipalPasswordCredential applets de commande et Remove-EntraServicePrincipalPasswordCredential les applets de commande pour mettre à jour le mot de passe ou le secret d’un servicePrincipal.

Exemple 7 : Mettre à jour PreferredSingleSignOnMode d’un principal de service

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -PreferredSingleSignOnMode 'saml'

Cet exemple montre comment mettre à jour PreferredSingleSignOnMode un principal de service dans Microsoft Entra ID.

  • -ServicePrincipalId spécifie l’ID d’un principal de service.
  • -PreferredSingleSignOnMode spécifie le mode d’authentification unique configuré pour cette application.

Paramètres

-AccountEnabled

Indique si le compte est activé.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AlternativeNames

Autres noms pour ce principal de service.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[System.String]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AppId

Spécifie l’ID d’application.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AppRoleAssignmentRequired

Indique si une attribution de rôle d’application est requise.

Propriétés du paramètre

Type:System.Boolean
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DisplayName

Spécifie le nom complet.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Homepage

Spécifie la page d’accueil ou la page d’accueil de l’application.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-KeyCredentials

Spécifie les informations d’identification de clé.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LogoutUrl

Spécifie l’URL de déconnexion.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PasswordCredentials

Spécifie les informations d’identification du mot de passe.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PreferredSingleSignOnMode

Spécifie le mode d’authentification unique configuré pour cette application. Microsoft Entra ID utilise le mode d’authentification unique préféré pour lancer l’application à partir de Microsoft 365 ou du portail Mes applications. Les valeurs prises en charge sont mot de passe, saml, notSupported et oidc.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ReplyUrls

Les URL auxquelles les jetons utilisateur sont envoyés pour se connecter à l’application associée, ou les identificateurs de ressource uniformes de redirection auxquels les codes d’autorisation et les jetons d’accès OAuth 2.0 sont envoyés pour l’application associée.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[System.String]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ServicePrincipalId

Espèces l’ID d’un principal de service dans Microsoft Entra ID.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Identifiant d'objet (ObjectId)

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ServicePrincipalNames

Spécifie les noms de principal de service.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[System.String]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ServicePrincipalType

Type de principal de service.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Tags

Spécifie un tableau de balises.

Si vous envisagez que ce principal de service s’affiche dans la liste Toutes les applications dans le portail d’administration, vous devez définir cette valeur sur {WindowsAzureActiveDirectoryIntegratedApp}.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[System.String]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.