Compartilhar via

New-MsolServicePrincipal

  • Referência
Módulo:
MSOnline

Adiciona uma entidade de serviço ao Azure Active Directory.

Sintaxe

New-MsolServicePrincipal
   [-ServicePrincipalNames <String[]>]
   [-AppPrincipalId <Guid>]
   -DisplayName <String>
   [-AccountEnabled <Boolean>]
   [-Addresses <RedirectUri[]>]
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]

Description

O cmdlet New-MsolServicePrincipal cria uma entidade de serviço que pode ser usada para representar um aplicativo lob (linha de negócios) ou um servidor local, como Microsoft Exchange, SharePoint ou Lync no Microsoft Azure Active Directory como objetos de entidade de serviço. O acréscimo de um novo aplicativo como um objeto de serviço permite que o aplicativo autentique para outros serviços, como o Microsoft Office 365.

Exemplos

Exemplo 1: Criar uma entidade de serviço

PS C:\> New-MsolServicePrincipal -ServicePrincipalNames @("MyApp/myApp.com") -DisplayName "My Application"

Esse comando cria uma entidade de serviço. Neste exemplo, a entidade de serviço é criada com o nome da entidade de serviço MyApp/myApp.com, o nome de exibição Meu Aplicativo e usará uma chave simétrica de 256 bits gerada automaticamente para verificar o aplicativo. Esta chave será válida para um ano a partir de hoje.

Exemplo 2: Criar uma entidade de serviço que usa um certificado X509

PS C:\> $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate
PS C:\> $cer.Import("C:\temp\myapp.cer")
PS C:\> $binCert = $cer.GetRawCertData()
PS C:\> $credValue = [System.Convert]::ToBase64String($binCert);
PS C:\> New-MsolServicePrincipal -ServicePrincipalNames @("MyApp/myApp.com") -DisplayName "My Application" -Type asymmetric -Value $credValue

Este exemplo cria uma entidade de serviço. Neste exemplo, a entidade de serviço é criada com o nome da entidade de serviço MyApp/myApp.com, o nome de exibição Meu Aplicativo e usa o certificado X509 fornecido myapp.cer configurado com uma chave assimétrica codificada em base 64.

Parâmetros

-AccountEnabled

Especifica se a conta precisa ser habilitada. O valor padrão é $True.

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

-Addresses

Especifica o dos endereços usados pelo aplicativo. Use o cmdlet New-MsolServicePrincipalAddresses para ajudar a criar o objeto de lista Addresses.

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

-AppPrincipalId

Especifica a ID exclusiva do aplicativo para uma entidade de serviço em um locatário. Depois de criada, essa propriedade não pode ser alterada. Se você não especificar esse parâmetro, a ID do aplicativo será gerada.

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

-DisplayName

Especifica um nome de exibição da entidade de serviço.

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

-EndDate

Especifica 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.

Tipo:DateTime
Cargo:Named
Valor padrão:Today + 1 year
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ServicePrincipalNames

Uma lista de SPNs (nomes de entidade de serviço) associados à entidade de serviço.

Um SPN deve ser exclusivo por locatário da empresa e é usado por um aplicativo para se identificar exclusivamente. Por padrão, o AppID da entidade de serviço sempre é adicionado como um SPN. Um SPN deve usar um dos seguintes formatos:

  • appName
  • appName/hostname
  • uma URL válida

AppName representa o nome do aplicativo e o nome do host representa a autoridade de URI do aplicativo. Quando a entidade de serviço representa um WS-Federation terceira parte confiável, um SPN pode ser definido como uma URL que seria tratada como o parâmetro wtrealm WS-Federation.

Tipo:String[]
Cargo:Named
Valor padrão:AppId of the service principal
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StartDate

Especifica a data de início efetiva do uso da credencial. O valor de data de início padrão é hoje.

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

-TenantId

Especifica a ID exclusiva do locatário no qual executar a operação. O valor padrão é o locatário do usuário atual. Esse parâmetro se aplica somente a usuários parceiros.

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

-Type

Especifica o tipo de credencial a ser usado. Os valores válidos são: assimétrica, simétrica e senha.

  • Se assimétrico, o parâmetro Value deverá ser definido como a parte pública de um certificado X509 codificado em base 64.
  • Se simétrica, uma chave simétrica AES de 256 bits será gerada se Value não estiver definido.
  • Se senha, o parâmetro Value deve ser especificado e não deve ser codificado em base 64.

A configuração padrão é "simétrica".

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

-Usage

Especifica o uso da chave de credencial. O uso da chave de credencial pode ser definido para assinar ou verificar um token. A configuração padrão é verificar.

O sinal é permitido SOMENTE para chaves simétricas. Verifique se é permitido para todos os tipos de chave.

Uma chave de credencial de verificação é exigida pelo Azure Active Directory para verificar se o token de solicitação foi enviado pelo aplicativo, representado por essa entidade de serviço. Opcionalmente, seu aplicativo pode exigir que o Azure Active Directory emita tokens para seu aplicativo assinados usando sua chave de assinatura em vez da chave pública assimétrica que identifica o Azure Active Directory. Nesse caso, forneça uma chave de credencial de sinal para sua entidade de serviço.

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

-Value

Especifica o valor da credencial.

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

Saídas

Microsoft.Online.Administration.ServicePrincipalExtended

Esse cmdlet retorna a entidade de serviço que ele adicionou. Isso inclui as seguintes informações:

  • Objectid. O identificador exclusivo da entidade de serviço.
  • AppPrincipalId. O identificador de aplicativo da entidade de serviço.
  • DisplayName. O nome amigável da entidade de serviço.
  • Serviceprincipalname. A lista de SPNs (nomes de entidade de serviço) associada à entidade de serviço.
  • TrustedForDelegation. O valor que indica se a entidade de serviço é permitida para delegação.
  • AccountEnabled. O valor que indica se a conta está habilitada.

Ele também recupera a lista de credenciais que foram adicionadas. Cada objeto de credencial contém as seguintes informações:

  • Digite. O tipo de credencial da entidade de serviço (assimétrica/simétrica/outra).
  • Value. O valor da credencial. Se o tipo de credencial for certificado, este representa o certificado codificado em base 64. Se o tipo de credencial for simétrico, ele representará uma chave AES.
  • KeyGroupId. O identificador reservado para uso interno.
  • KeyId. O identificador exclusivo da chave.
  • Startdate. A data de início efetiva do uso da credencial.
  • Enddate. A data de término efetiva do uso da credencial.
  • Uso. Especifica se a credencial é usada para assinar ou verificar um token.