Set-EntraServicePrincipal

Atualiza uma entidade de serviço.

Sintaxe

Default (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

O Set-EntraServicePrincipal cmdlet atualiza uma entidade de serviço no Microsoft Entra ID.

Exemplos

Exemplo 1: Desabilitar a conta de uma entidade 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 uma entidade de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica a ID de uma entidade de serviço.
  • -AccountEnabled especifica se a conta está habilitada.

Exemplo 2: atualizar a home page de uma entidade 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 e página inicial de uma entidade de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica a ID de uma entidade de serviço.
  • -AppId o parâmetro especifica a ID do aplicativo.
  • -Homepage o parâmetro especifica a home page ou a página de aterrissagem do aplicativo.

Exemplo 3: Atualizar AlternativeNames e DisplayName de uma entidade 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 uma entidade de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica a ID de uma entidade de serviço.

Exemplo 4: Atualizar LogoutUrl e ReplyUrls de uma entidade 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 LogoutUrl e ReplyUrls de uma entidade de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica a ID de uma entidade de serviço.
  • -LogoutUrl o parâmetro especifica a URL de saída.
  • -ReplyUrls O parâmetro especifica as URLs para as quais os tokens de usuário são enviados para entrar com o aplicativo associado.

Exemplo 5: Atualizar ServicePrincipalType e AppRoleAssignmentRequired de uma entidade 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 ServicePrincipalType e AppRoleAssignmentRequired de uma entidade de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica a ID de uma entidade de serviço.
  • -ServicePrincipalType o parâmetro especifica o tipo de entidade de serviço.
  • -AppRoleAssignmentRequired especifica se uma atribuição de função de aplicativo é necessária.

Exemplo 6: Atualizar KeyCredentials de uma entidade 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 KeyCredentials de uma entidade de serviço no Microsoft Entra ID.

Use os New-EntraServicePrincipalPasswordCredential cmdlets e Remove-EntraServicePrincipalPasswordCredential os cmdlets para atualizar a senha ou o segredo de um servicePrincipal.

Exemplo 7: Atualizar PreferredSingleSignOnMode de uma entidade 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 uma entidade de serviço no Microsoft Entra ID.

  • -ServicePrincipalId o parâmetro especifica a ID de uma entidade de serviço.
  • -PreferredSingleSignOnMode O parâmetro especifica o modo de logon único configurado para este aplicativo.

Parâmetros

-AccountEnabled

Indica se a conta está habilitada.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-AlternativeNames

Os nomes alternativos para essa entidade de serviço.

Propriedades do parâmetro

Tipo:

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

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-AppId

Especifica a ID do aplicativo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-AppRoleAssignmentRequired

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

Propriedades do parâmetro

Tipo:System.Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DisplayName

Especifica o nome de exibição.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Homepage

Especifica a home page ou a página inicial do aplicativo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-KeyCredentials

Especifica as credenciais de chave.

Propriedades do parâmetro

Tipo:

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

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-LogoutUrl

Especifica a URL de saída.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PasswordCredentials

Especifica credenciais de senha.

Propriedades do parâmetro

Tipo:

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

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PreferredSingleSignOnMode

Especifica o modo de logon único configurado para este aplicativo. Microsoft Entra ID utiliza o modo de início de sessão único preferencial para iniciar a aplicação a partir do Microsoft 365 ou do portal Meus Aplicativos. Os valores suportados são password, saml, notSupported e oidc.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ReplyUrls

As URLs para as quais os tokens de usuário são enviados para entrar com o aplicativo associado ou os Identificadores uniformes de recursos para os quais os códigos de autorização E tokens de acesso do OAuth 2.0 são enviados para o aplicativo associado.

Propriedades do parâmetro

Tipo:

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

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ServicePrincipalId

Espécie a ID de uma entidade de serviço em Microsoft Entra ID.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:IdentificadorDeObjeto

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ServicePrincipalNames

Especifica os nomes da entidade de serviço.

Propriedades do parâmetro

Tipo:

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

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ServicePrincipalType

O tipo de principal de serviço.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Tags

Especifica um array de tags.

Se você pretende que essa entidade de serviço apareça na lista Todos os Aplicativos no portal de administração, você precisará definir esse valor como {WindowsAzureActiveDirectoryIntegratedApp}.

Propriedades do parâmetro

Tipo:

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

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.