Set-EntraServicePrincipal

Aktualisiert einen Dienstprinzipal.

Syntax

Default (Standard)

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>]

Beschreibung

Das Set-EntraServicePrincipal Cmdlet aktualisiert einen Dienstprinzipal in Microsoft Entra ID.

Beispiele

Beispiel 1: Deaktivieren des Kontos eines Dienstprinzipals

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

In diesem Beispiel wird veranschaulicht, wie ein Dienstprinzipal in Microsoft Entra ID aktualisiert AccountEnabled wird.

  • -ServicePrincipalId der Parameter gibt die ID eines Dienstprinzipals an.
  • -AccountEnabled der Parameter gibt an, ob das Konto aktiviert ist.

Beispiel 2: Aktualisieren der Homepage eines Dienstprinzipals

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

In diesem Beispiel wird das Aktualisieren AppId und Die Homepage eines Dienstprinzipals in Microsoft Entra ID veranschaulicht.

  • -ServicePrincipalId der Parameter gibt die ID eines Dienstprinzipals an.
  • -AppId der Parameter gibt die Anwendungs-ID an.
  • -Homepage der Parameter gibt die Startseite oder Startseite der Anwendung an.

Beispiel 3: Aktualisieren von AlternativeNames und DisplayName eines Dienstprinzipals

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'

In diesem Beispiel wird veranschaulicht, wie AlternativeNames und DisplayName eines Dienstprinzipals in Microsoft Entra ID aktualisiert werden.

  • -ServicePrincipalId der Parameter gibt die ID eines Dienstprinzipals an.

Beispiel 4: Aktualisieren von LogoutUrl und ReplyUrls eines Dienstprinzipals

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

In diesem Beispiel wird veranschaulicht, wie LogoutUrl und ReplyUrls eines Dienstprinzipals in Microsoft Entra ID aktualisiert werden.

  • -ServicePrincipalId der Parameter gibt die ID eines Dienstprinzipals an.
  • -LogoutUrl der Parameter gibt die Abmelde-URL an.
  • -ReplyUrls der Parameter gibt die URLs an, an die Benutzertoken für die Anmeldung mit der zugehörigen Anwendung gesendet werden.

Beispiel 5: Aktualisieren von ServicePrincipalType und AppRoleAssignmentRequired eines Dienstprinzipals

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

In diesem Beispiel wird veranschaulicht, wie ein Dienstprinzipal in Microsoft Entra ID aktualisiert ServicePrincipalType wirdAppRoleAssignmentRequired.

  • -ServicePrincipalId der Parameter gibt die ID eines Dienstprinzipals an.
  • -ServicePrincipalType der Parameter gibt den Dienstprinzipaltyp an.
  • -AppRoleAssignmentRequired Der Parameter gibt an, ob eine Anwendungsrollenzuweisung erforderlich ist.

Beispiel 6: Aktualisieren von KeyCredentials eines Dienstprinzipals

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

In diesem Beispiel wird veranschaulicht, wie KeyCredentials eines Dienstprinzipals in Microsoft Entra ID aktualisiert wird.

Verwenden Sie die New-EntraServicePrincipalPasswordCredential Cmdlets, Remove-EntraServicePrincipalPasswordCredential um das Kennwort oder den geheimen Schlüssel für einen servicePrincipal zu aktualisieren.

Beispiel 7: Aktualisieren von PreferredSingleSignOnMode eines Dienstprinzipals

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

In diesem Beispiel wird veranschaulicht, wie ein Dienstprinzipal in Microsoft Entra ID aktualisiert PreferredSingleSignOnMode wird.

  • -ServicePrincipalId der Parameter gibt die ID eines Dienstprinzipals an.
  • -PreferredSingleSignOnMode der Parameter gibt den modus für einmaliges Anmelden an, der für diese Anwendung konfiguriert ist.

Parameter

-AccountEnabled

Gibt an, ob das Konto aktiviert ist.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-AlternativeNames

Die alternativen Namen für diesen Dienstprinzipal.

Parametereigenschaften

Typ:

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

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-AppId

Gibt die Anwendungs-ID an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-AppRoleAssignmentRequired

Gibt an, ob eine Anwendungsrollenzuweisung erforderlich ist.

Parametereigenschaften

Typ:System.Boolean
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-DisplayName

Gibt den Anzeigenamen an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Homepage

Gibt die Startseite oder Startseite der Anwendung an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-KeyCredentials

Gibt die wichtigsten Anmeldeinformationen an.

Parametereigenschaften

Typ:

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

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-LogoutUrl

Gibt die Abmelde-URL an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-PasswordCredentials

Gibt Kennwortanmeldeinformationen an.

Parametereigenschaften

Typ:

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

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-PreferredSingleSignOnMode

Gibt den Modus für einmaliges Anmelden an, der für diese Anwendung konfiguriert ist. Microsoft Entra ID verwendet den bevorzugten Modus für einmaliges Anmelden, um die Anwendung über Microsoft 365 oder das Meine Apps-Portal zu starten. Die unterstützten Werte sind "Password", "saml", "notSupported" und "oidc".

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ReplyUrls

Die URLs, an die Benutzertoken für die Anmeldung mit der zugeordneten Anwendung gesendet werden, oder die Umleitungs-Uniform Resource Identifiers, an die OAuth 2.0-Autorisierungscodes und Zugriffstoken für die zugeordnete Anwendung gesendet werden.

Parametereigenschaften

Typ:

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

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ServicePrincipalId

Gibt die ID eines Dienstprinzipals in Microsoft Entra ID ab.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Objekt-ID

Parametersätze

(All)
Position:Named
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-ServicePrincipalNames

Gibt Dienstprinzipalnamen an.

Parametereigenschaften

Typ:

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

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ServicePrincipalType

Der Dienstprinzipaltyp.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Tags

Gibt ein Array von Tags an.

Wenn Sie beabsichtigen, dass dieser Dienstprinzipal in der Liste "Alle Anwendungen" im Verwaltungsportal angezeigt wird, müssen Sie diesen Wert auf {WindowsAzureActiveDirectoryIntegratedApp} festlegen.

Parametereigenschaften

Typ:

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

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.