New-AzureRmADServicePrincipal

Cria uma nova entidade de serviço do Microsoft Entra.

Aviso

O módulo AzureRM PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Syntax

New-AzureRmADServicePrincipal
   [-ApplicationId <Guid>]
   [-DisplayName <String>]
   [-Password <SecureString>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Scope <String>]
   [-Role <String>]
   [-SkipAssignment]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationId <Guid>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationId <Guid>
   -Password <SecureString>
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationId <Guid>
   -PasswordCredential <PSADPasswordCredential[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationId <Guid>
   -CertValue <String>
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationId <Guid>
   -KeyCredential <PSADKeyCredential[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -DisplayName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -DisplayName <String>
   -Password <SecureString>
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -DisplayName <String>
   -PasswordCredential <PSADPasswordCredential[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -DisplayName <String>
   -CertValue <String>
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -DisplayName <String>
   -KeyCredential <PSADKeyCredential[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationObject <PSADApplication>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationObject <PSADApplication>
   -Password <SecureString>
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationObject <PSADApplication>
   -PasswordCredential <PSADPasswordCredential[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationObject <PSADApplication>
   -CertValue <String>
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmADServicePrincipal
   -ApplicationObject <PSADApplication>
   -KeyCredential <PSADKeyCredential[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cria uma nova entidade de serviço do Microsoft Entra. O conjunto de parâmetros padrão usa valores padrão para parâmetros se o usuário não fornecer um para eles. Para obter mais informações sobre os valores padrão usados, consulte a descrição dos parâmetros fornecidos abaixo. Este cmdlet tem a capacidade de atribuir uma função à entidade de serviço com os Role parâmetros e Scope e, se nenhum desses parâmetros for fornecido, nenhuma função será atribuída à entidade de serviço. Os valores padrão para os Role parâmetros e Scope são "Colaborador" e a assinatura atual, respectivamente (observação: os padrões só são usados quando o usuário fornece um valor para um dos dois parâmetros, mas não para o outro). O cmdlet também cria implicitamente um aplicativo e define suas propriedades (se o ApplicationId não for fornecido). Para atualizar os parâmetros específicos do aplicativo, use o cmdlet Set-AzureRmADApplication.

Exemplos

Exemplo 1 - Criação de entidade de serviço AD simples

PS C:\> New-AzureRmADServicePrincipal

Secret                : System.Security.SecureString
ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43}
ApplicationId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
DisplayName           : azure-powershell-05-22-2018-18-23-43
Id                    : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
Type                  : ServicePrincipal

O comando acima cria uma entidade de serviço do AD usando valores padrão para parâmetros não fornecidos. Como uma ID de aplicativo não foi fornecida, um aplicativo foi criado para a entidade de serviço. Como nenhum valor foi fornecido para Role ou Scope, a entidade de serviço criada não tem nenhuma permissão.

Exemplo 2 - Criação simples da entidade de serviço do AD com uma função especificada e um escopo padrão

PS C:\> New-AzureRmADServicePrincipal -Role Reader

Secret                : System.Security.SecureString
ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43}
ApplicationId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
DisplayName           : azure-powershell-05-22-2018-18-23-43
Id                    : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
Type                  : ServicePrincipal

WARNING: Assigning role 'Reader' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz' to the new service principal.

O comando acima cria uma entidade de serviço do AD usando os valores padrão para parâmetros não fornecidos. Como a ID do aplicativo não foi fornecida, um aplicativo foi criado para a entidade de serviço. A entidade de serviço foi criada com permissões de "Leitor" sobre a assinatura atual (uma vez que nenhum valor foi fornecido para o Scope parâmetro).

Exemplo 3 - Criação de entidade de serviço AD simples com um escopo especificado e função padrão

PS C:\> New-AzureRmADServicePrincipal -Scope /subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup

Secret                : System.Security.SecureString
ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43}
ApplicationId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
DisplayName           : azure-powershell-05-22-2018-18-23-43
Id                    : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
Type                  : ServicePrincipal

WARNING: Assigning role 'Contributor' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup' to the new service principal.

O comando acima cria uma entidade de serviço do AD usando os valores padrão para parâmetros não fornecidos. Como a ID do aplicativo não foi fornecida, um aplicativo foi criado para a entidade de serviço. A entidade de serviço foi criada com permissões de "Colaborador" (uma vez que nenhum valor foi fornecido para o Role parâmetro) sobre o escopo do grupo de recursos fornecido.

Exemplo 4 - Criação simples da entidade de serviço do AD com um escopo e uma função especificados

PS C:\> New-AzureRmADServicePrincipal -Role Reader -Scope /subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup

Secret                : System.Security.SecureString
ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43}
ApplicationId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
DisplayName           : azure-powershell-05-22-2018-18-23-43
Id                    : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
Type                  : ServicePrincipal

WARNING: Assigning role 'Reader' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup' to the new service principal.

O comando acima cria uma entidade de serviço do AD usando os valores padrão para parâmetros não fornecidos. Como a ID do aplicativo não foi fornecida, um aplicativo foi criado para a entidade de serviço. A entidade de serviço foi criada com permissões de "Leitor" sobre o escopo do grupo de recursos fornecido.

Exemplo 5 - Criar uma nova entidade de serviço do AD usando a ID do aplicativo com atribuição de função

PS C:\> New-AzureRmADServicePrincipal -ApplicationId 34a28ad2-dec4-4a41-bc3b-d22ddf90000e

ServicePrincipalNames : {34a28ad2-dec4-4a41-bc3b-d22ddf90000e, http://my-temp-app}
ApplicationId         : 34a28ad2-dec4-4a41-bc3b-d22ddf90000e
DisplayName           : my-temp-app
Id                    : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
Type                  : ServicePrincipal

Cria uma nova entidade de serviço do AD para o aplicativo com a ID do aplicativo '34a28ad2-dec4-4a41-bc3b-d22ddf90000e'. Como nenhum valor foi fornecido para Role ou Scope, a entidade de serviço criada não tem nenhuma permissão.

Exemplo 6 - Criar uma nova entidade de serviço do AD usando tubulação

PS C:\> Get-AzureRmADApplication -ObjectId 3ede3c26-b443-4e0b-9efc-b05e68338dc3 | New-AzureRmADServicePrincipal

Obtém o aplicativo com a id do objeto '3ede3c26-b443-4e0b-9efc-b05e68338dc3' e canaliza isso para o cmdlet New-AzureRmADServicePrincipal para criar uma nova entidade de serviço do AD para esse aplicativo.

Parâmetros

-ApplicationId

A ID de aplicativo exclusiva para uma entidade de serviço em um locatário. Uma vez criada, esta propriedade não pode ser alterada. Se um ID de aplicativo não for especificado, um será gerado.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ApplicationObject

O objeto que representa o aplicativo para o qual a entidade de serviço é criada.

Type:PSADApplication
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-CertValue

O valor do tipo de credencial "assimétrica". Ele representa o certificado codificado base 64.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

O nome amigável da entidade de serviço. Se um nome de exibição não for fornecido, esse valor será padrão para 'azure-powershell-MM-dd-yyyy-HH-mm-ss', onde o sufixo é a hora da criação do aplicativo.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-EndDate

A data de término efetiva do uso da credencial. O valor de data de término padrão é de um ano a partir de hoje. Para uma credencial de tipo "assimétrica", ela deve ser definida como na ou antes da data em que o certificado X509 é válido.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyCredential

A coleção de credenciais de chave associadas ao aplicativo.

Type:PSADKeyCredential[]
Aliases:KeyCredentials
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Password

A senha a ser associada à entidade de serviço. Se uma senha não for fornecida, um GUID aleatório será gerado e usado como senha.

Type:SecureString
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PasswordCredential

A coleção de credenciais de senha associadas ao aplicativo.

Type:PSADPasswordCredential[]
Aliases:PasswordCredentials
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Role

A função que a entidade de serviço tem sobre o escopo. Se um valor for Scope fornecido, mas nenhum valor for fornecido para Role, o Role padrão será a função 'Colaborador'.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

O escopo no qual a entidade de serviço tem permissões. Se um valor for Role fornecido, mas nenhum valor for fornecido para Scope, o Scope padrão será a assinatura atual.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipAssignment

Se definido, ignorará a criação da atribuição de função padrão para a entidade de serviço.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StartDate

A data de início efetiva do uso da credencial. O valor de data de início padrão é hoje. Para uma credencial de tipo "assimétrica", ela deve ser definida como na data ou após a data em que o certificado X509 é válido.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

Guid

String

PSADApplication

Parâmetros: ApplicationObject (ByValue)

PSADPasswordCredential[]

PSADKeyCredential[]

SecureString

DateTime

Saídas

PSADServicePrincipal

Microsoft.Azure.Commands.Resources.Models.Authorization.PSADServicePrincipalWrapper

Notas

Palavras-chave: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment