Udostępnij za pośrednictwem

New-MsolServicePrincipal

  • Odwołanie
Moduł:
MSOnline

Dodaje jednostkę usługi do usługi Azure Active Directory.

Składnia

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

Opis

Polecenie cmdlet New-MsolServicePrincipal tworzy jednostkę usługi, która może służyć do reprezentowania aplikacji biznesowej (LOB) lub serwera lokalnego, takiego jak Microsoft Exchange, SharePoint lub Lync w usłudze Microsoft Azure Active Directory jako obiekty jednostki usługi. Dodanie nowej aplikacji jako jednostki usługi umożliwia aplikacji uwierzytelnianie w innych usługach, takich jak Microsoft Office 365.

Przykłady

Przykład 1. Tworzenie jednostki usługi

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

To polecenie tworzy jednostkę usługi. W tym przykładzie jednostka usługi jest tworzona z nazwą główną usługi MyApp/myApp.com, nazwą wyświetlaną Moja aplikacja i będzie używać automatycznie wygenerowanego 256-bitowego klucza symetrycznego, aby zweryfikować aplikację. Ten klucz będzie ważny przez rok od dzisiaj.

Przykład 2. Tworzenie jednostki usługi korzystającej z certyfikatu 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

W tym przykładzie zostanie utworzona jednostka usługi. W tym przykładzie jednostka usługi jest tworzona z nazwą główną usługi MyApp/myApp.com, nazwą wyświetlaną Moja aplikacja i używa dostarczonego certyfikatu X509 myapp.cer skonfigurowanego przy użyciu klucza asymetrycznego zakodowanego w formacie base 64.

Parametry

-AccountEnabled

Określa, czy konto musi być włączone. Wartość domyślna to $True.

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

-Addresses

Określa adresy używane przez aplikację. Użyj polecenia cmdlet New-MsolServicePrincipalAddresses , aby ułatwić tworzenie obiektu listy Adresy.

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

-AppPrincipalId

Określa unikatowy identyfikator aplikacji dla jednostki usługi w dzierżawie. Po utworzeniu tej właściwości nie można zmienić. Jeśli nie określisz tego parametru, zostanie wygenerowany identyfikator aplikacji.

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

-DisplayName

Określa nazwę wyświetlaną jednostki usługi.

Typ:String
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ń. Domyślna wartość daty zakończenia to jeden rok od dzisiaj.

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

-ServicePrincipalNames

Lista głównych nazw usług (SPN) skojarzonych z jednostką usługi.

Nazwa SPN musi być unikatowa dla dzierżawy firmy i jest używana przez aplikację do unikatowego identyfikowania siebie. Domyślnie identyfikator AppID jednostki usługi jest zawsze dodawany jako nazwa SPN. Nazwa SPN musi używać jednego z następujących formatów:

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

AppName reprezentuje nazwę aplikacji, a nazwa hosta reprezentuje urząd URI aplikacji. Gdy jednostka usługi reprezentuje jednostkę uzależnioną WS-Federation, nazwę SPN można ustawić na adres URL, który będzie traktowany jako parametr WS-Federation wtrealm.

Typ:String[]
Position:Named
Domyślna wartość:AppId of the service principal
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-StartDate

Określa obowiązującą datę rozpoczęcia użycia poświadczeń. Domyślna wartość daty rozpoczęcia to dzisiaj.

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 poświadczeń do użycia. Prawidłowe wartości to: asymetryczne, symetryczne i hasło.

  • Jeśli asymetryczny parametr Value musi być ustawiony na publiczną część certyfikatu X509 zakodowanego w formacie base 64.
  • Jeśli symetryczna, zostanie wygenerowany 256-bitowy klucz symetryczny AES, jeśli wartość nie jest ustawiona.
  • Jeśli hasło, należy określić parametr Value i nie powinien być zakodowany w formacie base 64.

Ustawieniem domyślnym jest "symetryczna".

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. Ustawienie domyślne jest weryfikowane.

Znak jest dozwolony tylko dla kluczy symetrycznych. Sprawdź, czy jest dozwolone dla wszystkich typów kluczy.

Sprawdź, czy klucz poświadczeń jest wymagany przez usługę Azure Active Directory, aby sprawdzić, czy token żądania został wysłany przez aplikację reprezentowany przez tę jednostkę usługi. Aplikacja może opcjonalnie wymagać tokenów wystawiania tokenów usługi Azure Active Directory do aplikacji podpisanej przy użyciu klucza podpisywania, a nie asymetrycznego klucza publicznego identyfikującego usługę 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ń.

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

Dane wyjściowe

Microsoft.Online.Administration.ServicePrincipalExtended

To polecenie cmdlet zwraca jednostkę usługi, którą dodał. Obejmuje to następujące informacje:

  • Objectid. Unikatowy identyfikator jednostki usługi.
  • AppPrincipalId. Identyfikator aplikacji jednostki usługi.
  • Displayname. Przyjazna nazwa jednostki usługi.
  • Serviceprincipalname. Lista głównych nazw usług (SPN) skojarzonych z jednostką usługi.
  • TrustedForDelegation. Wartość wskazująca, czy jednostka usługi jest dozwolona dla delegowania.
  • AccountEnabled. Wartość wskazująca, czy konto jest włączone.

Pobiera również listę dodanych poświadczeń. Każdy obiekt poświadczeń zawiera następujące informacje:

  • Typu. Typ poświadczeń jednostki usługi (asymetryczna/symetryczna/inna).
  • Wartość. Wartość poświadczenia. Jeśli typ poświadczeń to certyfikat, reprezentuje certyfikat zakodowany w formacie base 64. Jeśli typ poświadczeń jest symetryczny, reprezentuje klucz AES.
  • KeyGroupId. Identyfikator zarezerwowany do użytku wewnętrznego.
  • KeyId. Unikatowy identyfikator klucza.
  • Startdate. Data rozpoczęcia użycia poświadczeń.
  • Enddate. Obowiązująca data zakończenia użycia poświadczeń.
  • Użycie. Określa, czy poświadczenie jest używane do podpisywania lub weryfikowania tokenu.