Set-EntraServicePrincipal
更新服務負責人。
語法
Default (預設值)
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
Set-EntraServicePrincipal該 cmdlet 會更新 Microsoft Entra ID 中的服務主體。
範例
範例 1:停用服務主體的帳號
Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -AccountEnabled $false
此範例示範如何在 Microsoft Entra ID 中更新AccountEnabled服務主體。
-
-ServicePrincipalId參數指定服務主體的識別碼。 -
-AccountEnabled參數 指定表示帳號是否啟用。
範例 2:更新服務主體的首頁
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
此範例示範如何在 Microsoft Entra ID 中更新AppId服務主體的首頁。
-
-ServicePrincipalId參數指定服務主體的識別碼。 -
-AppId參數指定應用程式 ID。 -
-Homepage參數指定應用程式的首頁或著陸頁。
範例 3:更新服務主體的 AlternativeNames 與 DisplayName
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'
此範例示範如何在 Microsoft Entra ID 中更新服務主體的 AlternativeNames 與 DisplayName。
-
-ServicePrincipalId參數指定服務主體的識別碼。
範例 4:更新服務主體的 LogoutUrl 與 ReplyUrls
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
此範例示範如何在 Microsoft Entra ID 中更新服務主體的 LogoutUrl 與 ReplyUrls。
-
-ServicePrincipalId參數指定服務主體的識別碼。 -
-LogoutUrl參數指定登出 URL。 -
-ReplyUrls參數指定使用者憑證傳送至 URL 以登入相關應用程式。
範例 5:Update ServicePrincipalType 與 AppRoleAssignmentRequired(服務主體的必要作業)
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
此範例示範如何在 Microsoft Entra ID 中更新ServicePrincipalType服務AppRoleAssignmentRequired主體。
-
-ServicePrincipalId參數指定服務主體的識別碼。 -
-ServicePrincipalType參數指定服務主體類型。 -
-AppRoleAssignmentRequired參數 specation 表示是否需要應用程式角色指派。
範例 6:更新服務主體的 KeyCredentials
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
此範例示範如何在 Microsoft Entra ID 中更新服務主體的 KeyCredentials。
使用 New-EntraServicePrincipalPasswordCredential and Remove-EntraServicePrincipalPasswordCredential 指令長來更新 servicePrincipal 的密碼或秘密。
範例 7:更新服務主體的 PreferredSingleSignOnMode
Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
Set-EntraServicePrincipal -ServicePrincipalId $servicePrincipal.Id -PreferredSingleSignOnMode 'saml'
此範例示範如何在 Microsoft Entra ID 中更新PreferredSingleSignOnMode服務主體。
-
-ServicePrincipalId參數指定服務主體的識別碼。 -
-PreferredSingleSignOnMode參數指定為此應用所設定的單一登入模式。
參數
-AccountEnabled
顯示帳號是否已啟用。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AlternativeNames
這位服務負責人的別名。
參數屬性
| 類型: | System.Collections.Generic.List`1[System.String] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AppId
指定應用程式 ID。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AppRoleAssignmentRequired
指示是否需要應用程式角色指派。
參數屬性
| 類型: | System.Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DisplayName
指定顯示名稱。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Homepage
指定申請的首頁或登陸頁。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-KeyCredentials
指定關鍵憑證。
參數屬性
| 類型: | System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-LogoutUrl
指定登出網址。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PasswordCredentials
指定密碼憑證。
參數屬性
| 類型: | System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PreferredSingleSignOnMode
指定為此應用程式設定的單一登錄模式。 Microsoft Entra ID 會使用慣用的單一登錄模式,從 Microsoft 365 或 我的應用程式 入口網站啟動應用程式。 支援的值為 password、saml、notSupported 和 oidc。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ReplyUrls
使用者憑證用於與相關應用程式登入的網址,或是 OAuth 2.0 授權碼與存取憑證所傳送的 Uniform Resource Identifiers。
參數屬性
| 類型: | System.Collections.Generic.List`1[System.String] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ServicePrincipalId
物種是 Microsoft Entra ID 中服務主體的 ID。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | ObjectId (物件識別碼) |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ServicePrincipalNames
指定服務負責人名稱。
參數屬性
| 類型: | System.Collections.Generic.List`1[System.String] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ServicePrincipalType
服務主要負責人類型。
參數屬性
| 類型: | System.String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Tags
指定一組標記的陣列。
如果你打算讓這個服務主體出現在管理入口網站的「所有應用程式」清單中,你需要將此值設為 {WindowsAzureActiveDirectoryIntegratedApp}。
參數屬性
| 類型: | System.Collections.Generic.List`1[System.String] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。