New-EntraServicePrincipal
Cria um princípio de serviço.
Sintaxe
Default (Predefinição)
New-EntraServicePrincipal
-AppId <String>
[-KeyCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]>]
[-Homepage <String>]
[-LogoutUrl <String>]
[-ServicePrincipalType <String>]
[-AlternativeNames <System.Collections.Generic.List`1[System.String]>]
[-PasswordCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]>]
[-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
Crie um novo Diretor de serviço.
Para aplicações multiinquilino, o utilizador que chama deve também estar em pelo menos uma das seguintes funções Microsoft Entra:
- Administrador de Aplicações
- Administrador de aplicativos na nuvem
Para aplicações de inquilino único onde o utilizador que chama é um utilizador não administrador mas é o proprietário da aplicação de apoio, o utilizador deve ter o papel de Desenvolvedor de Aplicações.
Exemplos
Exemplo 1: Criar um novo principal de serviço usando DisplayName, AccountEnabled, Tags e AppRoleAssignmentRequired
Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$params = @{
AccountEnabled = $true
AppId = $application.AppId
AppRoleAssignmentRequired = $true
DisplayName = $application.DisplayName
Tags = {WindowsAzureActiveDirectoryIntegratedApp}
}
New-EntraServicePrincipal @params
DisplayName Id AppId SignInAudience ServicePrincipalType
----------- -- ----- -------------- --------------------
Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application
Este exemplo demonstra como criar um novo Service Principal no Microsoft Entra ID. Pode usar o comando Get-EntraApplication para obter o ID da aplicação aplicação.
A tag -Tags {WindowsAzureActiveDirectoryIntegratedApp} é usada para que este principal de serviço apareça na lista de Aplicações Integradas no Portal de Administração.
-
-AccountEnabledO parâmetro especifica verdadeiro se a conta principal do serviço estiver ativada, caso contrário falso. -
-AppIdo parâmetro especifica o identificador único para a aplicação associada (a sua propriedade appId). -
-DisplayNameO parâmetro especifica o nome de exibição do principal do serviço. -
-AppRoleAssignmentRequiredO parâmetro indica se é necessária uma atribuição de papel de aplicação.
Exemplo 2: Criar um novo principal de serviço usando Homepage, logoutUrl e ReplyUrls
Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$params = @{
AppId = $application.AppId
Homepage = 'https://localhost/home'
LogoutUrl = 'htpp://localhost/logout'
ReplyUrls = 'https://localhost/redirect'
}
New-EntraServicePrincipal @params
DisplayName Id AppId SignInAudience ServicePrincipalType
----------- -- ----- -------------- --------------------
Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application
Este exemplo demonstra como criar um novo Service Principal no Microsoft Entra ID. Pode usar o comando Get-EntraApplication para obter o ID da aplicação aplicação.
-
-AppIdo parâmetro especifica o identificador único para a aplicação associada (a sua propriedade appId). -
-HomepageO parâmetro especifica a página inicial ou página inicial da aplicação. -
-LogoutUrlo parâmetro especifica o URL de logout. -
-ReplyUrlsparâmetro especifica as URLs para onde os tokens de utilizador são enviados para iniciar sessão com a aplicação associada.
Exemplo 3: Criar um novo principal de serviço através do KeyCredentials
Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$creds = New-Object Microsoft.Open.AzureAD.Model.KeyCredential
$creds.CustomKeyIdentifier = [System.Text.Encoding]::UTF8.GetBytes('Test')
$startdate = Get-Date -Year 2023 -Month 10 -Day 23
$creds.StartDate = $startdate
$creds.Type = 'Symmetric'
$creds.Usage = 'Sign'
$creds.Value = [System.Text.Encoding]::UTF8.GetBytes('strong-cred-value')
$creds.EndDate = Get-Date -Year 2024 -Month 10 -Day 23
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
New-EntraServicePrincipal -AppId $application.AppId -KeyCredentials $creds
DisplayName Id AppId SignInAudience ServicePrincipalType
----------- -- ----- -------------- --------------------
Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application
Este exemplo demonstra como criar um novo Service Principal no Microsoft Entra ID. Pode usar o comando Get-EntraApplication para obter o ID da aplicação aplicação.
-
-AppIdo parâmetro especifica o identificador único para a aplicação associada (a sua propriedade appId). -
-KeyCredentialsO parâmetro especifica a coleção de credenciais-chave associada ao principal do serviço.
Exemplo 4: Criar um novo principal de serviço por NomesAlternativos, TipoPrincipalServiço e NomePrincipalServiço
Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
New-EntraServicePrincipal -AppId $application.AppId -AlternativeNames 'sktest2' -ServicePrincipalType 'Application' -ServicePrincipalNames $application.AppId
DisplayName Id AppId SignInAudience ServicePrincipalType
----------- -- ----- -------------- --------------------
Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADandPersonalMicrosoftAccount Application
Este exemplo demonstra como criar um novo Service Principal no Microsoft Entra ID. Pode usar o comando Get-EntraApplication para obter o ID da aplicação aplicação.
-
-AppIdo parâmetro especifica o identificador único para a aplicação associada (a sua propriedade appId). -
-AlternativeNamesO parâmetro especifica os nomes alternativos para este principal de serviço. -
-ServicePrincipalTypeO parâmetro especifica o tipo do principal de serviço. -
-ServicePrincipalNamesO parâmetro especifica um array de nomes de principais de serviço.
Parâmetros
-AccountEnabled
Verdadeiro se a conta do principal de serviço estiver ativada; caso contrário, falso.
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
O identificador exclusivo para o aplicativo associado (sua propriedade appId).
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: | True |
| 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 de exibição principal do 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 |
-Homepage
Página inicial ou página de destino do aplicativo.
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
A coleção de credenciais de chave associadas à entidade de serviço.
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 a URL de logout.
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
A coleção de credenciais de senha associadas ao aplicativo.
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 |
-ReplyUrls
As URLs para as quais os tokens de usuário são enviados para entrar com o aplicativo associado ou os URIs de redirecionamento para os quais os códigos de autorização OAuth 2.0 e os tokens de acesso são enviados para o aplicativo associado.
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 |
-ServicePrincipalNames
Especifica um conjunto de nomes de principal de serviço. Com base na coleção identifierURIs, mais na propriedade appId da aplicação, estes URIs são usados para referenciar o principal de serviço da aplicação. Um cliente utiliza ServicePrincipalNames para:
- preencher requiredResourceAccess, via "Permissões para outras aplicações" no portal clássico do Azure.
- Especifique um URI de recurso para adquirir um token de acesso, que é o URI devolvido na reivindicaçã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 diretor 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
Etiquetas ligadas a este princípio de serviço.
Note que, 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.