Set-EntraServicePrincipal

Atualiza um princípio de serviço.

Sintaxe

Default (Predefinição)

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

Descrição

O Set-EntraServicePrincipal cmdlet atualiza um principal de serviço no Microsoft Entra ID.

Exemplos

Exemplo 1: Desativar a conta de um principal de serviço

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

Este exemplo demonstra como atualizar AccountEnabled um principal de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica o ID de um principal de serviço.
  • -AccountEnabled parâmetros especifica indica se a conta está ativada.

Exemplo 2: Atualizar a página inicial de um principal de serviço

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

Este exemplo demonstra como atualizar AppId a página inicial de um principal de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica o ID de um principal de serviço.
  • -AppId parâmetro especifica o ID da aplicação.
  • -Homepage O parâmetro especifica a página inicial ou página inicial da aplicação.

Exemplo 3: Atualizar AlternativeNames e DisplayName de um principal de serviço

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'

Este exemplo demonstra como atualizar AlternativeNames e DisplayName de um principal de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica o ID de um principal de serviço.

Exemplo 4: Atualizar o LogoutUrl e os ReplyUrls de um principal de serviço

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

Este exemplo demonstra como atualizar o LogoutUrl e o ReplyUrls de um principal de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica o ID de um principal de serviço.
  • -LogoutUrl o parâmetro especifica a URL de encerramento de sessão.
  • -ReplyUrls parâmetro especifica as URLs para onde os tokens de utilizador são enviados para iniciar sessão com a aplicação associada.

Exemplo 5: Atualizar ServicePrincipalType e AppRoleAssignmentRequired de um principal de serviço

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

Este exemplo demonstra como atualizar ServicePrincipalTypeAppRoleAssignmentRequired um princípio de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica o ID de um principal de serviço.
  • -ServicePrincipalType O parâmetro especifica o tipo principal do serviço.
  • -AppRoleAssignmentRequired parâmetros especifica indica se é necessária uma atribuição de funções de aplicação.

Exemplo 6: Atualizar KeyCredentials de um principal de serviço

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

Este exemplo demonstra como atualizar as KeyCredentials de um principal de serviço no Microsoft Entra ID.

Use os New-EntraServicePrincipalPasswordCredential comandos e Remove-EntraServicePrincipalPasswordCredential para atualizar a palavra-passe ou o segredo de um ServicePrincipal.

Exemplo 7: Atualizar PreferredSingleSignOnMode de um principal de serviço

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

Este exemplo demonstra como atualizar PreferredSingleSignOnMode um principal de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica o ID de um principal de serviço.
  • -PreferredSingleSignOnMode O parâmetro especifica o modo de login único configurado para esta aplicação.

Parâmetros

-AccountEnabled

Indica se a conta está ativada.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-AlternativeNames

Os nomes alternativos para este principal de serviço.

Propriedades dos parâmetros

Tipo:

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

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-AppId

Especifica o ID da aplicação.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-AppRoleAssignmentRequired

Indica se é necessária uma atribuição de função de candidatura.

Propriedades dos parâmetros

Tipo:System.Boolean
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DisplayName

Especifica o nome para exibição.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Homepage

Especifica a página inicial ou landing page da candidatura.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-KeyCredentials

Especifica credenciais-chave.

Propriedades dos parâmetros

Tipo:

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

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-LogoutUrl

Especifica o URL de desligamento.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PasswordCredentials

Especifica credenciais de palavra-passe.

Propriedades dos parâmetros

Tipo:

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

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PreferredSingleSignOnMode

Especifica o modo de logon único configurado para este aplicativo. O Microsoft Entra ID usa o modo de logon único preferido para iniciar o aplicativo do Microsoft 365 ou do portal Meus Aplicativos. Os valores suportados são password, saml, notSupported e oidc.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ReplyUrls

Os URLs para onde os tokens de utilizador são enviados para iniciar sessão com a aplicação associada, ou os Identificadores Uniformes de Recursos de redirecionamento para onde os códigos de autorização OAuth 2.0 e os tokens de acesso são enviados para a aplicação associada.

Propriedades dos parâmetros

Tipo:

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

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ServicePrincipalId

Espécie: o ID de um principal de serviço no Microsoft Entra ID.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:IdentificadorDoObjeto

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-ServicePrincipalNames

Especifica os nomes dos principais de serviço.

Propriedades dos parâmetros

Tipo:

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

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ServicePrincipalType

O tipo de princípio de serviço.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Tags

Especifica uma matriz de tags.

Se pretende que este principal de serviço apareça na lista de Todas as Aplicações no portal de administração, precisa de definir este valor para {WindowsAzureActiveDirectoryIntegratedApp}.

Propriedades dos parâmetros

Tipo:

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

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.