Set-EntraServicePrincipal

Aktualizuje jednostkę usługi.

Składnia

Default (domyślnie)

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

Opis

Polecenie Set-EntraServicePrincipal cmdlet aktualizuje jednostkę usługi w Microsoft Entra ID.

Przykłady

Przykład 1. Wyłączanie konta jednostki usługi

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

W tym przykładzie pokazano, jak zaktualizować AccountEnabled jednostkę usługi w Microsoft Entra ID.

  • -ServicePrincipalId parametr określa identyfikator jednostki usługi.
  • -AccountEnabled parametr określa, czy konto jest włączone.

Przykład 2. Aktualizowanie strony głównej jednostki usługi

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

W tym przykładzie pokazano, jak zaktualizować AppId i stronę główną jednostki usługi w Microsoft Entra ID.

  • -ServicePrincipalId parametr określa identyfikator jednostki usługi.
  • -AppId parametr określa identyfikator aplikacji.
  • -Homepage parametr określa stronę główną lub stronę docelową aplikacji.

Przykład 3: Aktualizowanie wartości AlternativeNames i DisplayName jednostki usługi

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'

W tym przykładzie pokazano, jak zaktualizować wartości AlternativeNames i DisplayName jednostki usługi w Microsoft Entra ID.

  • -ServicePrincipalId parametr określa identyfikator jednostki usługi.

Przykład 4. Aktualizowanie elementu LogoutUrl i ReplyUrls jednostki usługi

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

W tym przykładzie pokazano, jak zaktualizować element LogoutUrl i ReplyUrls jednostki usługi w Microsoft Entra ID.

  • -ServicePrincipalId parametr określa identyfikator jednostki usługi.
  • -LogoutUrl parametr określa adres URL wylogowywania.
  • -ReplyUrls Parametr określa adresy URL, do których są wysyłane tokeny użytkownika na potrzeby logowania się w skojarzonej aplikacji.

Przykład 5. Aktualizacja parametrów ServicePrincipalType i AppRoleAssignmentRequired jednostki usługi

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

W tym przykładzie pokazano, jak zaktualizować ServicePrincipalType jednostkę usługi i AppRoleAssignmentRequired w Microsoft Entra ID.

  • -ServicePrincipalId parametr określa identyfikator jednostki usługi.
  • -ServicePrincipalType parametr określa typ jednostki usługi.
  • -AppRoleAssignmentRequired Parametr określa, czy przypisanie roli aplikacji jest wymagane.

Przykład 6. Aktualizowanie wartości KeyCredentials jednostki usługi

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

W tym przykładzie pokazano, jak zaktualizować wartości KeyCredentials jednostki usługi w Microsoft Entra ID.

Użyj poleceń New-EntraServicePrincipalPasswordCredential cmdlet i Remove-EntraServicePrincipalPasswordCredential , aby zaktualizować hasło lub wpis tajny dla elementu servicePrincipal.

Przykład 7. Aktualizacja preferredSingleSignOnMode jednostki usługi

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

W tym przykładzie pokazano, jak zaktualizować PreferredSingleSignOnMode jednostkę usługi w Microsoft Entra ID.

  • -ServicePrincipalId parametr określa identyfikator jednostki usługi.
  • -PreferredSingleSignOnMode parametr określa tryb logowania jednokrotnego skonfigurowany dla tej aplikacji.

Parametry

-AccountEnabled

Wskazuje, czy konto jest włączone.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AlternativeNames

Alternatywne nazwy dla tej jednostki usługi.

Właściwości parametru

Typ:

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

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AppId

Określa identyfikator aplikacji.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AppRoleAssignmentRequired

Wskazuje, czy wymagane jest przypisanie roli aplikacji.

Właściwości parametru

Typ:System.Boolean
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DisplayName

Określa nazwę wyświetlaną.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Homepage

Określa stronę główną lub stronę docelową aplikacji.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-KeyCredentials

Określa poświadczenia klucza.

Właściwości parametru

Typ:

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

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-LogoutUrl

Określa adres URL wylogowywania.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PasswordCredentials

Określa poświadczenia hasła.

Właściwości parametru

Typ:

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

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PreferredSingleSignOnMode

Określa tryb logowania jednokrotnego skonfigurowany dla tej aplikacji. Microsoft Entra ID używa preferowanego trybu logowania jednokrotnego, aby uruchomić aplikację z platformy Microsoft 365 lub portalu Moje aplikacje. Obsługiwane wartości to hasło, saml, notSupported i oidc.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ReplyUrls

Adresy URL, do których są wysyłane tokeny użytkownika w celu logowania się ze skojarzzoną aplikacją, lub przekierowywanie identyfikatorów jednolitych zasobów, do których są wysyłane kody autoryzacji protokołu OAuth 2.0 i tokeny dostępu dla skojarzonej aplikacji.

Właściwości parametru

Typ:

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

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ServicePrincipalId

Określa identyfikator jednostki usługi w Microsoft Entra ID.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Identyfikator Obiektu

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-ServicePrincipalNames

Określa nazwy główne usługi.

Właściwości parametru

Typ:

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

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ServicePrincipalType

Typ jednostki usługi.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Tags

Określa tablicę tagów.

Jeśli zamierzasz, aby ta jednostka usługi pojawiła się na liście Wszystkie aplikacje w portalu administracyjnym, musisz ustawić tę wartość na {WindowsAzureActiveDirectoryIntegratedApp}.

Właściwości parametru

Typ:

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

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.