New-MsolServicePrincipalCredential

  • Referência
Módulo:
MSOnline

Adicione uma chave de credencial a uma entidade de serviço.

Syntax

New-MsolServicePrincipalCredential
   -ObjectId <Guid>
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]
New-MsolServicePrincipalCredential
   -ServicePrincipalName <String>
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]
New-MsolServicePrincipalCredential
   -AppPrincipalId <Guid>
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]

Description

O cmdlet New-MsolServicePrincipalCredential adiciona uma nova credencial a uma entidade de serviço ou adiciona ou rola chaves de credencial para um aplicativo. A entidade de serviço é identificada fornecendo a ID do objeto, a ID da entidade de aplicativo ou o SPN (nome da entidade de serviço).

Exemplos

Exemplo 1: Adicionar uma credencial existente a uma entidade de serviço

PS C:\> $Certificate = New-Object System.Security.Cryptography.X509Certificates.X509Certificate
PS C:\> $Certificate.Import("C:\myapp.cer")
PS C:\> $BinCert = $Certificate.GetRawCertData()
PS C:\> $CredValue = [System.Convert]::ToBase64String($binCert);
PS C:\> New-MsolServicePrincipalCredential -ServicePrincipalName "MyApp/myApp.com" -Type asymmetric -Value $CredValue -StartDate $Certificate.GetEffectiveDateString() -EndDate $Certificate.GetExpirationDateString()

Este exemplo adiciona uma credencial ou um objeto de chave a uma entidade de serviço existente. Neste exemplo, o certificado X509 público codificado em base64, chamado myapp.cer, é adicionado à entidade de serviço usando o valor do nome da entidade de serviço myApp/myApp.com.

Exemplo 2: Registrar um Exchange Server local

PS C:\> New-MsolServicePrincipalCredential -AppPrincipalId  -Type asymmetric -Value $CredValue

Esse comando registra uma Exchange Server local para que as comunicações entre os serviços Exchange Server e Microsoft Azure Active Directory, como Office 365, possam ocorrer. Este exemplo assume que o $credValue contém o certificado público X509 codificado com base 64 usado para representar o Exchange Server local. As IDs conhecidas para servidores Office 365 são:

  • Exchange: 00000002-0000-0ff1-ce00-0000000000000
  • SharePoint: 00000003-0000-0ff1-ce00-0000000000000
  • Lync: 00000004-0000-0ff1-ce00-0000000000000

Parâmetros

-AppPrincipalId

Especifica a ID do aplicativo da entidade de serviço à qual adicionar a credencial.

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

-EndDate

Especifica a data de término efetiva do uso da credencial. O valor padrão é um ano a partir de hoje. Para uma credencial de tipo assimétrico, isso deve ser definido como em ou antes da data em que o certificado X509 é válido até que, caso contrário, um token OAuth não será emitido para este aplicativo.

Type:DateTime
Position:Named
Default value:Today + 1 year
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

Especifica a ID de objeto exclusiva da entidade de serviço à qual adicionar a credencial.

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

-ServicePrincipalName

Especifica o nome da entidade de serviço à qual adicionar a credencial. Um SPN deve usar um dos seguintes formatos:

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

AppName representa o nome do aplicativo. O nome do host representa a autoridade de URI para o aplicativo.

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

-StartDate

Especifica a data de início efetiva do uso da credencial. O valor padrão é hoje. Para uma credencial de tipo assimétrico, isso deve ser definido como em ou após a data da qual o certificado X509 é válido, caso contrário, um token OAuth não será emitido para este aplicativo.

Type:DateTime
Position:Named
Default value:Today
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

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

-Type

Especifica o tipo de credencial usada. Os valores válidos são:

  • assimétricas
  • simétricas
  • password

O valor padrão é simétrico.

Importante

Chaves assimétricas são recomendadas. As chaves simétricas não são seguras e serão desabilitadas para entidades de serviço que acessam aplicativos de primeira parte da Microsoft.

Type:ServicePrincipalCredentialType
Position:Named
Default value:Symmetric
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Usage

Especifica o uso da chave de credencial. O uso da chave de credencial pode ser definido para assinar ou verificar um token. O valor 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 é necessária pelo diretório do Azure Active Directory para verificar se o token de solicitação foi enviado pelo aplicativo, que é representado por essa entidade de serviço.

Opcionalmente, seu aplicativo pode exigir que os serviços do Azure Active Directory emitam tokens para seu aplicativo assinados com sua chave de assinatura em vez da chave pública assimétrica que identifica Microsoft Azure Active Directory. Nesse caso, forneça uma chave de credencial de sinal para sua entidade de serviço.

Type:ServicePrincipalCredentialUsage
Position:Named
Default value:Verify
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Value

Especifica o valor da credencial.

  • Se o tipo de credencial for assimétrico, o valor representará o certificado codificado em base 64.
  • Se o tipo de credencial for simétrico e o parâmetro Value não for especificado, uma chave AES de 256 bits será criada automaticamente e válida por um ano a partir da criação.
  • Se o tipo de credencial for password, especifique Value. Ele não deve ser codificado em base 64.
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False