Compartilhar via

New-AzureRmADServicePrincipal

  • Referência
Módulo:
AzureRM.Resources

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

Aviso

O módulo PowerShell do AzureRM 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 do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.

Sintaxe

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. Esse cmdlet tem a capacidade de atribuir uma função à entidade de serviço com os Role parâmetros e Scope ; 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ão usados apenas 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 simples da entidade de serviço do AD

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 permissões.

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" na assinatura atual (já que nenhum valor foi fornecido para o Scope parâmetro).

Exemplo 3 – Criação simples da entidade de serviço do AD com um escopo especificado e uma 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" (já que nenhum valor foi fornecido para o Role parâmetro) no 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" no 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 00001111-aaaa-2222-bbbb-3333cccc4444

ServicePrincipalNames : {00001111-aaaa-2222-bbbb-3333cccc4444, http://my-temp-app}
ApplicationId         : 00001111-aaaa-2222-bbbb-3333cccc4444
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 '00001111-aaaa-2222-bbbb-3333cccc4444'. Como nenhum valor foi fornecido para Role ou Scope, a entidade de serviço criada não tem permissões.

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 de 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 exclusiva do aplicativo para uma entidade de serviço em um locatário. Uma vez criada, essa propriedade não pode ser alterada. Se um ID de aplicativo não for especificado, um será gerado.

Tipo:Guid
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ApplicationObject

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

Tipo:PSADApplication
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-CertValue

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DisplayName

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EndDate

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

Tipo:DateTime
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-KeyCredential

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

Tipo:PSADKeyCredential[]
Aliases:KeyCredentials
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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.

Tipo:SecureString
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-PasswordCredential

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

Tipo:PSADPasswordCredential[]
Aliases:PasswordCredentials
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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'.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Scope

O escopo para o 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.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SkipAssignment

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-StartDate

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

Tipo:DateTime
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

Guid

String

PSADApplication

Parâmetros: ApplicationObject (ByValue)

PSADPasswordCredential[]

PSADKeyCredential[]

SecureString

DateTime

Saídas

PSADServicePrincipal

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

Observações

Palavras-chave: azure, azurerm, arm, recurso, gerenciamento, gerente, recurso, grupo, modelo, implantação