Udostępnij za pośrednictwem

New-MsolServicePrincipalCredential

  • Odwołanie
Moduł:
MSOnline

Dodaj klucz poświadczeń do jednostki usługi.

Składnia

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>]

Opis

Polecenie cmdlet New-MsolServicePrincipalCredential dodaje nowe poświadczenia do jednostki usługi lub dodaje lub wprowadza klucze poświadczeń dla aplikacji. Jednostka usługi jest identyfikowana przez podanie identyfikatora obiektu, identyfikatora jednostki aplikacji lub nazwy głównej usługi (SPN).

Przykłady

Przykład 1. Dodawanie istniejącego poświadczenia do jednostki usługi

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

W tym przykładzie dodano poświadczenie lub klucz do istniejącej jednostki usługi. W tym przykładzie dostarczony publiczny certyfikat X509 zakodowany w formacie base64 o nazwie myapp.cer jest dodawany do jednostki usługi przy użyciu wartości głównej nazwy usługi MyApp/myApp.com.

Przykład 2. Rejestrowanie lokalnego Exchange Server

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

To polecenie rejestruje lokalną Exchange Server, aby komunikacja między usługami Exchange Server i Microsoft Azure Active Directory, takimi jak Office 365. W tym przykładzie założono, że $credValue zawiera certyfikat X509 zakodowany w formacie base64 używany do reprezentowania lokalnego serwera Exchange. Znane identyfikatory serwerów Office 365 to:

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

Parametry

-AppPrincipalId

Określa identyfikator aplikacji jednostki usługi, do której ma zostać dodane poświadczenie.

Typ:Guid
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-EndDate

Określa obowiązującą datę zakończenia użycia poświadczeń. Wartość domyślna to jeden rok od dzisiaj. W przypadku poświadczeń typu asymetrycznego musi to być ustawione na wartość on lub przed datą ważności certyfikatu X509, w przeciwnym razie token OAuth nie zostanie wystawiony dla tej aplikacji.

Typ:DateTime
Position:Named
Domyślna wartość:Today + 1 year
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ObjectId

Określa unikatowy identyfikator obiektu jednostki usługi, do której ma zostać dodane poświadczenie.

Typ:Guid
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ServicePrincipalName

Określa nazwę jednostki usługi, do której ma zostać dodane poświadczenie. Nazwa SPN musi używać jednego z następujących formatów:

  • appName
  • appName/hostname
  • prawidłowy adres URL

AppName reprezentuje nazwę aplikacji. Nazwa hosta reprezentuje urząd URI aplikacji.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-StartDate

Określa obowiązującą datę rozpoczęcia użycia poświadczeń. Wartość domyślna to dzisiaj. W przypadku poświadczeń typu asymetrycznego musi to być ustawione na wartość on lub po dacie ważności certyfikatu X509, w przeciwnym razie token OAuth nie zostanie wystawiony dla tej aplikacji.

Typ:DateTime
Position:Named
Domyślna wartość:Today
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-TenantId

Określa unikatowy identyfikator dzierżawy, na którym ma być wykonywana operacja. Wartość domyślna to dzierżawa bieżącego użytkownika. Ten parametr dotyczy tylko użytkowników partnerów.

Typ:Guid
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Type

Określa typ używanego poświadczenia. Prawidłowe wartości:

  • Asymetrycznego
  • Symetrycznego
  • hasło

Wartość domyślna to symetryczna.

Ważne

Zalecane są klucze asymetryczne. Klucze symetryczne nie są bezpieczne i zostaną wyłączone dla jednostek usługi, które uzyskują dostęp do aplikacji firmy Microsoft.

Typ:ServicePrincipalCredentialType
Position:Named
Domyślna wartość:Symmetric
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Usage

Określa użycie klucza poświadczeń. Użycie klucza poświadczeń można ustawić na podpisywanie lub weryfikowanie tokenu. Wartość domyślna jest weryfikowana. Znak jest dozwolony tylko dla kluczy symetrycznych. Sprawdź, czy jest dozwolone dla wszystkich typów kluczy.

Sprawdź, czy klucz poświadczeń jest wymagany przez katalog usługi Azure Active Directory, aby sprawdzić, czy token żądania został wysłany przez aplikację, która jest reprezentowana przez tę jednostkę usługi.

Aplikacja może opcjonalnie wymagać, aby usługi Azure Active Directory wystawiały tokeny do aplikacji podpisanej przy użyciu klucza podpisywania, a nie asymetrycznego klucza publicznego identyfikującego Microsoft Azure Active Directory. W takim przypadku podaj klucz poświadczeń podpisywania dla jednostki usługi.

Typ:ServicePrincipalCredentialUsage
Position:Named
Domyślna wartość:Verify
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Value

Określa wartość poświadczeń.

  • Jeśli typ poświadczeń jest asymetryczny, wartość reprezentuje certyfikat zakodowany w formacie base 64.
  • Jeśli typ poświadczeń jest symetryczny, a parametr Value nie zostanie określony, 256-bitowy klucz AES zostanie automatycznie utworzony i ważny przez jeden rok od utworzenia.
  • Jeśli typ poświadczeń to hasło, określ wartość. Nie powinien być zakodowany w formacie base 64.
Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False