Delen via

New-MsolServicePrincipalCredential

  • Referentie
Module:
MSOnline

Voeg een referentiesleutel toe aan een service-principal.

Syntaxis

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

De cmdlet New-MsolServicePrincipalCredential voegt een nieuwe referentie toe aan een service-principal of voegt referentiesleutels voor een toepassing toe of rolt deze. De service-principal wordt geïdentificeerd door de object-id, app-principal-id of service-principal name (SPN) op te geven.

Voorbeelden

Voorbeeld 1: Een bestaande referentie toevoegen aan een service-principal

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

In dit voorbeeld wordt een referentie- of sleutelobject toegevoegd aan een bestaande service-principal. In dit voorbeeld wordt het opgegeven base64 gecodeerde openbare X509-certificaat, met de naam myapp.cer, toegevoegd aan de service-principal met behulp van de waarde van de service-principalnaam MyApp/myApp.com.

Voorbeeld 2: Een on-premises Exchange Server registreren

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

Met deze opdracht wordt een on-premises Exchange Server geregistreerd, zodat communicatie tussen de Exchange Server en Microsoft Azure Active Directory services zoals Office 365 kan plaatsvinden. In dit voorbeeld wordt ervan uitgegaan dat $credValue het met base64 gecodeerde openbare X509-certificaat bevat dat wordt gebruikt om de on-premises Exchange-server te vertegenwoordigen. De bekende id's voor Office 365 servers zijn:

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

Parameters

-AppPrincipalId

Hiermee geeft u de toepassings-id van de service-principal waaraan de referentie moet worden toegevoegd.

Type:Guid
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-EndDate

Hiermee geeft u de effectieve einddatum van het referentiegebruik op. De standaardwaarde is één jaar vanaf vandaag. Voor een asymmetrische typereferentie moet deze worden ingesteld op op of vóór de datum waarop het X509-certificaat geldig is tot, anders wordt er geen OAuth-token uitgegeven voor deze toepassing.

Type:DateTime
Position:Named
Default value:Today + 1 year
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ObjectId

Hiermee geeft u de unieke object-id van de service-principal waaraan de referentie moet worden toegevoegd.

Type:Guid
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ServicePrincipalName

Hiermee geeft u de naam van de service-principal waaraan de referentie moet worden toegevoegd. Een SPN moet een van de volgende indelingen gebruiken:

  • appName
  • appName/hostname
  • een geldige URL

AppName vertegenwoordigt de naam van de toepassing. Hostnaam vertegenwoordigt de URI-instantie voor de toepassing.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-StartDate

Hiermee geeft u de effectieve begindatum van het gebruik van referenties op. De standaardwaarde is vandaag. Voor een asymmetrische typereferentie moet deze worden ingesteld op op of na de datum waarop het X509-certificaat geldig is, anders wordt er geen OAuth-token uitgegeven voor deze toepassing.

Type:DateTime
Position:Named
Default value:Today
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-TenantId

Hiermee geeft u de unieke id van de tenant op waarop de bewerking moet worden uitgevoerd. De standaardwaarde is de tenant van de huidige gebruiker. Deze parameter is alleen van toepassing op partnergebruikers.

Type:Guid
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Type

Hiermee geeft u het type referentie gebruikt. Geldige waarden zijn:

  • Asymmetrische
  • Symmetrische
  • wachtwoord

De standaardwaarde is symmetrisch.

Belangrijk

Asymmetrische sleutels worden aanbevolen. Symmetrische sleutels zijn niet veilig en worden uitgeschakeld voor service-principals die toegang hebben tot eigen toepassingen van Microsoft.

Type:ServicePrincipalCredentialType
Position:Named
Default value:Symmetric
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Usage

Hiermee geeft u het gebruik van de referentiesleutel op. Het gebruik van de referentiesleutel kan worden ingesteld om een token te ondertekenen of te verifiëren. De standaardwaarde is verifiëren. Ondertekenen is ALLEEN toegestaan voor symmetrische sleutels. Controleren is toegestaan voor alle sleuteltypen.

Een verificatiereferentiesleutel is vereist voor de Azure Active Directory-directory om te controleren of het aanvraagtoken is verzonden door uw toepassing, die wordt vertegenwoordigd door deze service-principal.

Uw toepassing kan optioneel vereisen dat Azure Active Directory-services tokens uitgeven aan uw toepassing die zijn ondertekend met uw ondertekeningssleutel in plaats van de asymmetrische openbare sleutel die Microsoft Azure Active Directory identificeert. Geef in dit geval een aanmeldingsreferentiesleutel op voor uw service-principal.

Type:ServicePrincipalCredentialUsage
Position:Named
Default value:Verify
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Value

Hiermee geeft u de waarde van de referentie.

  • Als het referentietype asymmetrisch is, vertegenwoordigt de waarde het met base 64 gecodeerde certificaat.
  • Als het referentietype symmetrisch is en de waardeparameter niet is opgegeven, wordt automatisch een 256-bits AES-sleutel gemaakt die één jaar na het maken geldig is.
  • Als het referentietype wachtwoord is, geeft u Waarde op. Het mag niet zijn gecodeerd met base 64.
Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False