New-MsolServicePrincipalCredential

  • Referencia
Módulo:
MSOnline

Agregue una clave de credencial a una entidad de servicio.

Sintaxis

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

El cmdlet New-MsolServicePrincipalCredential agrega una nueva credencial a una entidad de servicio o agrega o acumula claves de credencial para una aplicación. La entidad de servicio se identifica proporcionando el identificador de objeto, el identificador de entidad de seguridad de la aplicación o el nombre de entidad de seguridad de servicio (SPN).

Ejemplos

Ejemplo 1: Agregar una credencial existente a una entidad de servicio

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()

En este ejemplo se agrega una credencial, o una clave, un objeto a una entidad de servicio existente. En este ejemplo, el certificado X509 público codificado en base64 proporcionado, denominado myapp.cer, se agrega a la entidad de servicio mediante el valor de nombre de entidad de servicio de MyApp/myApp.com.

Ejemplo 2: Registrar un Exchange Server local

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

Este comando registra una Exchange Server local para que se puedan producir comunicaciones entre el Exchange Server y los servicios de Microsoft Azure Active Directory, como Office 365. Este ejemplo supone que $credValue contiene el certificado público X509 codificado en base 64 usado para representar el servidor de Exchange local. Los identificadores conocidos para Office 365 servidores son:

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

Parámetros

-AppPrincipalId

Especifica el identificador de aplicación de la entidad de servicio a la que se va a agregar la credencial.

Tipo:Guid
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-EndDate

Especifica la fecha de finalización efectiva del uso de credenciales. El valor predeterminado es un año de hoy. Para una credencial de tipo asimétrico, debe establecerse en on o before the date that the X509 certificate is valid until, otherwise an OAuth token will not be issued for this application.

Tipo:DateTime
Posición:Named
Valor predeterminado:Today + 1 year
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ObjectId

Especifica el identificador de objeto único de la entidad de servicio a la que se va a agregar la credencial.

Tipo:Guid
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ServicePrincipalName

Especifica el nombre de la entidad de servicio a la que se va a agregar la credencial. Un SPN debe usar uno de los siguientes formatos:

  • appName
  • appName/hostname
  • una dirección URL válida

AppName representa el nombre de la aplicación. El nombre de host representa la entidad de URI de la aplicación.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-StartDate

Especifica la fecha de inicio efectiva del uso de credenciales. El valor predeterminado es hoy. Para una credencial de tipo asimétrico, debe establecerse en on o after the date that the X509 certificate is valid from, otherwise an OAuth token will not be issued for this application.

Tipo:DateTime
Posición:Named
Valor predeterminado:Today
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-TenantId

Especifica el identificador único del inquilino en el que se va a realizar la operación. El valor predeterminado es el inquilino del usuario actual. Este parámetro solo se aplica a los usuarios asociados.

Tipo:Guid
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Type

Especifica el tipo de credencial usada. Los valores válidos son:

  • asimétricas
  • simétricas
  • password

El valor predeterminado es simétrico.

Importante

Se recomiendan claves asimétricas. Las claves simétricas no son seguras y se deshabilitarán para las entidades de servicio que acceden a las aplicaciones propias de Microsoft.

Tipo:ServicePrincipalCredentialType
Posición:Named
Valor predeterminado:Symmetric
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Usage

Especifica el uso de la clave de credencial. El uso de la clave de credencial puede establecerse para firmar o comprobar un token. El valor predeterminado es verify. Solo se permite firmar para claves simétricas. Compruebe que se permite para todos los tipos de clave.

El directorio de Azure Active Directory requiere una clave de credencial de comprobación para comprobar que la aplicación envió el token de solicitud, representado por esta entidad de servicio.

Opcionalmente, la aplicación puede requerir que los servicios de Azure Active Directory emita tokens en la aplicación firmados con la clave de firma en lugar de la clave pública asimétrica que identifique Microsoft Azure Active Directory. En este caso, proporcione una clave de credencial de firma para la entidad de servicio.

Tipo:ServicePrincipalCredentialUsage
Posición:Named
Valor predeterminado:Verify
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Value

Especifica el valor de la credencial.

  • Si el tipo de credencial es asimétrico, el valor representa el certificado codificado en base 64.
  • Si el tipo de credencial es simétrico y no se especifica el parámetro Value , se crea automáticamente una clave AES de 256 bits y es válida durante un año a partir de la creación.
  • Si el tipo de credencial es password, especifique Value. No debe estar codificado en base 64.
Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False