New-EntraServicePrincipal

Tworzy jednostkę usługi.

Składnia

Default (domyślnie)

New-EntraServicePrincipal

    -AppId <String>
    [-KeyCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]>]
    [-Homepage <String>]
    [-LogoutUrl <String>]
    [-ServicePrincipalType <String>]
    [-AlternativeNames <System.Collections.Generic.List`1[System.String]>]
    [-PasswordCredentials <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]>]
    [-Tags <System.Collections.Generic.List`1[System.String]>]
    [-AccountEnabled <String>]
    [-ServicePrincipalNames <System.Collections.Generic.List`1[System.String]>]
    [-AppRoleAssignmentRequired <Boolean>]
    [-DisplayName <String>]
    [-ReplyUrls <System.Collections.Generic.List`1[System.String]>]
    [<CommonParameters>]

Opis

Utwórz nową jednostkę usługi.

W przypadku aplikacji wielodostępnych użytkownik wywołujący musi również należeć do co najmniej jednej z następujących ról Microsoft Entra:

  • Administrator aplikacji
  • Administrator aplikacji w chmurze

W przypadku aplikacji z jedną dzierżawą, w których użytkownik wywołujący jest użytkownikiem niebędącym administratorem, ale jest właścicielem aplikacji zapasowej, użytkownik musi mieć rolę dewelopera aplikacji.

Przykłady

Przykład 1: Tworzenie nowej jednostki usługi przy użyciu wartości DisplayName, AccountEnabled, Tags i AppRoleAssignmentRequired

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$params = @{
    AccountEnabled = $true
    AppId = $application.AppId
    AppRoleAssignmentRequired = $true
    DisplayName = $application.DisplayName
    Tags = {WindowsAzureActiveDirectoryIntegratedApp}
}
New-EntraServicePrincipal @params
DisplayName Id                                   AppId                                SignInAudience ServicePrincipalType
----------- --                                   -----                                -------------- --------------------
Helpdesk Application    bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg   Application

W tym przykładzie pokazano, jak utworzyć nową jednostkę usługi w Microsoft Entra ID. Aby uzyskać identyfikator aplikacji, możesz użyć polecenia Get-EntraApplication .

Tag -Tags {WindowsAzureActiveDirectoryIntegratedApp} służy do wyświetlania tej jednostki usługi na liście zintegrowanych aplikacji w portalu administracyjnym.

  • -AccountEnabled Parametr określa wartość true, jeśli konto jednostki usługi jest włączone, w przeciwnym razie wartość false.
  • -AppId parametr określa unikatowy identyfikator skojarzonej aplikacji (jej właściwość appId).
  • -DisplayName parametr określa nazwę wyświetlaną jednostki usługi.
  • -AppRoleAssignmentRequired parametr wskazuje, czy wymagane jest przypisanie roli aplikacji.

Przykład 2. Tworzenie nowej jednostki usługi przy użyciu strony głównej, wylogowywania i odpowiedziUrls

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$params = @{
    AppId = $application.AppId
    Homepage = 'https://localhost/home'
    LogoutUrl = 'htpp://localhost/logout'
    ReplyUrls = 'https://localhost/redirect'
}
New-EntraServicePrincipal @params
DisplayName Id                                   AppId                                SignInAudience ServicePrincipalType
----------- --                                   -----                                -------------- --------------------
Helpdesk Application    bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg   Application

W tym przykładzie pokazano, jak utworzyć nową jednostkę usługi w Microsoft Entra ID. Aby uzyskać identyfikator aplikacji, możesz użyć polecenia Get-EntraApplication .

  • -AppId parametr określa unikatowy identyfikator skojarzonej aplikacji (jej właściwość appId).
  • -Homepage parametr określa stronę główną lub stronę docelową aplikacji.
  • -LogoutUrl parametr określa adres URL wylogowywania.
  • -ReplyUrls Parametr określa adresy URL, do których są wysyłane tokeny użytkownika na potrzeby logowania się w skojarzonej aplikacji.

Przykład 3. Tworzenie nowej jednostki usługi według elementu KeyCredentials

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$creds = New-Object Microsoft.Open.AzureAD.Model.KeyCredential
$creds.CustomKeyIdentifier = [System.Text.Encoding]::UTF8.GetBytes('Test')
$startdate = Get-Date -Year 2023 -Month 10 -Day 23
$creds.StartDate = $startdate
$creds.Type = 'Symmetric'
$creds.Usage = 'Sign'
$creds.Value = [System.Text.Encoding]::UTF8.GetBytes('strong-cred-value')
$creds.EndDate = Get-Date -Year 2024 -Month 10 -Day 23
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"

New-EntraServicePrincipal -AppId $application.AppId -KeyCredentials $creds
DisplayName Id                                   AppId                                SignInAudience ServicePrincipalType
----------- --                                   -----                                -------------- --------------------
Helpdesk Application    bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg   Application

W tym przykładzie pokazano, jak utworzyć nową jednostkę usługi w Microsoft Entra ID. Aby uzyskać identyfikator aplikacji, możesz użyć polecenia Get-EntraApplication .

  • -AppId parametr określa unikatowy identyfikator skojarzonej aplikacji (jej właściwość appId).
  • -KeyCredentials parametr określa kolekcję poświadczeń klucza skojarzonych z jednostką usługi.

Przykład 4: Tworzenie nowej jednostki usługi według wartości AlternativeNames, ServicePrincipalType i ServicePrincipalName

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
New-EntraServicePrincipal -AppId $application.AppId -AlternativeNames 'sktest2' -ServicePrincipalType 'Application' -ServicePrincipalNames $application.AppId
DisplayName Id                                   AppId                                SignInAudience                     ServicePrincipalType
----------- --                                   -----                                --------------                     --------------------
Helpdesk Application   bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADandPersonalMicrosoftAccount Application

W tym przykładzie pokazano, jak utworzyć nową jednostkę usługi w Microsoft Entra ID. Aby uzyskać identyfikator aplikacji, możesz użyć polecenia Get-EntraApplication .

  • -AppId parametr określa unikatowy identyfikator skojarzonej aplikacji (jej właściwość appId).
  • -AlternativeNames parametr określa alternatywne nazwy dla tej jednostki usługi.
  • -ServicePrincipalType parametr określa typ jednostki usługi.
  • -ServicePrincipalNames parametr określa tablicę nazw głównych usługi.

Parametry

-AccountEnabled

Prawda, jeśli konto jednostki usługi jest włączone; w przeciwnym razie false.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AlternativeNames

Alternatywne nazwy dla tej jednostki usługi.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[System.String]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AppId

Unikatowy identyfikator skojarzonej aplikacji (jej właściwość appId).

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AppRoleAssignmentRequired

Wskazuje, czy wymagane jest przypisanie roli aplikacji.

Właściwości parametru

Typ:System.Boolean
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DisplayName

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

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Homepage

Strona główna lub strona docelowa aplikacji.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-KeyCredentials

Kolekcja poświadczeń klucza skojarzonych z jednostką usługi.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-LogoutUrl

Określa adres URL wylogowywania.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PasswordCredentials

Kolekcja poświadczeń hasła skojarzonych z aplikacją.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ReplyUrls

Adresy URL, do których są wysyłane tokeny użytkownika w celu logowania się ze skojarzzoną aplikacją, lub identyfikatory URI przekierowania, do których są wysyłane kody autoryzacji protokołu OAuth 2.0 i tokeny dostępu dla skojarzonej aplikacji.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[System.String]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ServicePrincipalNames

Określa tablicę nazw głównych usług. Na podstawie kolekcji identifierURIs oraz właściwości appId aplikacji te identyfikatory URI są używane do odwołowania się do jednostki usługi aplikacji. Klient używa atrybutów ServicePrincipalNames do:

  • wypełnij wartość requiredResourceAccess za pośrednictwem pozycji "Uprawnienia do innych aplikacji" w portalu klasycznym Azure.
  • Określ identyfikator URI zasobu, aby uzyskać token dostępu, który jest identyfikatorem URI zwróconym w oświadczeniu.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[System.String]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ServicePrincipalType

Typ jednostki usługi.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Tags

Tagi połączone z tą jednostką usługi.

Należy pamiętać, że jeśli zamierzasz, aby ta jednostka usługi pojawiła się na liście Wszystkie aplikacje w portalu administracyjnym, musisz ustawić tę wartość na {WindowsAzureActiveDirectoryIntegratedApp}.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[System.String]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.