Set-EntraServicePrincipal

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

Set-EntraServicePrincipal コマンドレットは、Microsoft Entra IDのサービス プリンシパルを更新します。

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 パラメーターは、サービス プリンシパルの ID を指定します。
• -AccountEnabled パラメーターは、アカウントが有効かどうかを示します。

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 パラメーターは、サービス プリンシパルの ID を指定します。
• -AppId パラメーターはアプリケーション ID を指定します。
• -Homepage パラメーターは、アプリケーションのホーム ページまたはランディング ページを指定します。

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 パラメーターは、サービス プリンシパルの ID を指定します。

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 パラメーターは、サービス プリンシパルの ID を指定します。
• -LogoutUrl パラメーターはサインアウト URL を指定します。
• -ReplyUrls パラメーターは、関連付けられたアプリケーションでサインインするためにユーザー トークンが送信される URL を指定します。

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 パラメーターは、サービス プリンシパルの ID を指定します。
• -ServicePrincipalType パラメーターは、サービス プリンシパルの種類を指定します。
• -AppRoleAssignmentRequired パラメーターは、アプリケーション ロールの割り当てが必要かどうかを示します。

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コマンドレットとRemove-EntraServicePrincipalPasswordCredential コマンドレットを使用して、servicePrincipal のパスワードまたはシークレットを更新します。

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 パラメーターは、サービス プリンシパルの ID を指定します。
• -PreferredSingleSignOnMode パラメーターは、このアプリケーション用に構成されたシングル サインオン モードを指定します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。