New-EntraInvitation

Invitare un nuovo utente esterno alla directory.

Sintassi

Default (Impostazione predefinita)

New-EntraInvitation

    [-InvitedUser <User>]
    [-InvitedUserType <String>]
    -InvitedUserEmailAddress <String>
    [-SendInvitationMessage <Boolean>]
    [-ResetRedemption]
    -InviteRedirectUrl <String>
    [-InvitedUserMessageInfo <InvitedUserMessageInfo>]
    [-InvitedUserDisplayName <String>]
    [<CommonParameters>]

Descrizione

Questo cmdlet viene usato per invitare un nuovo utente esterno alla directory.

L'invito aggiunge un utente esterno all'organizzazione. Quando si crea un nuovo invito, sono disponibili diverse opzioni:

  • Durante la creazione dell'invito, Microsoft Graph può inviare automaticamente un messaggio di posta elettronica di invito direttamente all'utente invitato oppure l'app può usare inviteRedeemUrl restituito nella risposta per creare il proprio invito (tramite il meccanismo di comunicazione preferito) all'utente invitato. Se si decide di avere Microsoft Graph inviare automaticamente un messaggio di posta elettronica di invito, è possibile specificare il contenuto e la lingua del messaggio di posta elettronica usando invitedUserMessageInfo.

  • Quando l'utente viene invitato, viene creata un'entità utente (di userType Guest) e può essere usata per controllare l'accesso alle risorse. L'utente invitato deve eseguire il processo di riscatto per accedere alle risorse a cui è stato invitato.

Per reimpostare lo stato di riscatto per un utente guest, l'autorizzazione User.ReadWrite.All è il requisito minimo necessario.

Per gli scenari delegati, l'utente connesso deve avere almeno uno dei ruoli seguenti:

  • Invitante Ospite
  • Scrittori della Directory
  • Amministratore utenti

Inoltre, per reimpostare lo stato di riscatto, l'utente connesso deve avere:

  • Amministratore del supporto tecnico
  • Ruolo Amministratore utenti

Esempio

Esempio 1: Invitare un nuovo utente esterno alla directory

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.contoso.com'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl
Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

Questo esempio ha inviato un messaggio di posta elettronica all'utente che ha l'indirizzo di posta elettronica nel -InvitedUserEmailAddress parametro .

Quando l'utente accetta l'invito, viene inoltrato all'URL come specificato nel -InviteRedirectUrl parametro .

  • -SendInvitationMessage Il parametro indica se all'utente invitato verrà inviato o meno un messaggio di invito.

Esempio 2: Invitare un nuovo utente esterno alla directory con il parametro InvitedUserDisplayName

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.onmicrosoft.com'
$displayName = 'microsoftuser'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl -InvitedUserDisplayName $displayName
Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In questo esempio viene illustrato come invitare un nuovo utente esterno alla directory con -InvitedUserDisplayName il parametro .

  • -InvitedUserEmailAddressParametro specifica l'indirizzo di posta elettronica a cui viene inviato l'invito.
  • -SendInvitationMessage Il parametro indica se un messaggio di invito verrà inviato all'utente invitato
  • -InviteRedirectUrl Parametro specifica l'URL a cui l'utente invitato viene inoltrato dopo l'accettazione dell'invito.
  • -InvitedUserDisplayNameIl parametro specifica il nome visualizzato dell'utente.

Esempio 3: Invitare un nuovo utente esterno alla directory con il parametro InviteUserMessageInfo

Connect-Entra -Scopes 'User.Invite.All'
$a= New-Object Microsoft.Open.MSGraph.Model.InvitedUserMessageInfo
$a.CustomizedMessageBody = 'Hi there, how are you'
$a.MessageLanguage = 'EN'
$params = @{
    InvitedUserEmailAddress = 'someexternaluser@externaldomain.com'
    SendInvitationMessage = $True
    InviteRedirectUrl = 'https://myapps.microsoft.com'
    InvitedUserMessageInfo = $a
}

New-EntraInvitation @params
Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In questo esempio viene illustrato come invitare un nuovo utente esterno alla directory con il parametro InviteUserMessageInfo.

  • -InvitedUserEmailAddressParametro specifica l'indirizzo di posta elettronica a cui viene inviato l'invito.
  • -SendInvitationMessage Il parametro indica se all'utente invitato verrà inviato o meno un messaggio di invito.
  • -InviteRedirectUrl Parametro specifica l'URL a cui l'utente invitato viene inoltrato dopo l'accettazione dell'invito.
  • -InvitedUserMessageInfoIl parametro specifica le informazioni di addizione per specificare la modalità di invio del messaggio di invito.

Esempio 4: Invitare un nuovo utente esterno alla directory con il parametro InviteUserType

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.onmicrosoft.com'
$userType = 'Guest'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl -InvitedUserType $userType
Id                                   InviteRedeemUrl
--                                   ---------------
9e2b9f02-c2cb-4832-920d-81959f44e397 https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In questo esempio viene illustrato come invitare un nuovo utente esterno alla directory con il parametro InvitedUserType.

Esempio 5: Reimpostare un riscatto per un utente esterno

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.constoso.com'
$displayName = 'microsoftuser'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl -InvitedUserDisplayName $displayName -ResetRedemption
Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In questo esempio viene illustrato come un amministratore può reimpostare il riscatto per un utente esterno nel -InvitedUser parametro . È necessario passare l'opzione -ResetRedemption. Dopo la reimpostazione, l'utente esterno deve riscattare nuovamente l'invito per continuare ad accedere alle risorse.

Parametri

-InvitedUser

Oggetto utente esistente nella directory per cui si desidera aggiungere o aggiornare le credenziali B2B.

Proprietà dei parametri

Tipo:User
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InvitedUserDisplayName

Nome visualizzato dell'utente così come viene visualizzato nella directory.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InvitedUserEmailAddress

Indirizzo di posta elettronica a cui viene inviato l'invito.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InvitedUserMessageInfo

Informazioni aggiuntive per specificare la modalità di invio del messaggio di invito.

Proprietà dei parametri

Tipo:InvitedUserMessageInfo
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InvitedUserType

UserType dell'utente invitato. Per impostazione predefinita, si tratta di Guest.

È possibile invitare come membro se si è amministratori dell'azienda.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InviteRedirectUrl

URL a cui l'utente invitato viene inoltrato dopo l'accettazione dell'invito.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ResetRedemption

Indica se il riscatto dell'invito su un utente esterno esistente deve essere rimosso in modo che l'utente possa riscattare nuovamente l'account.

Per impostazione predefinita, questo valore è false e deve essere impostato solo quando si passa un utente esterno valido alla proprietà InvitedUser.

Proprietà dei parametri

Tipo:System.Management.Automation.SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-SendInvitationMessage

Parametro booleano che indica se un messaggio di invito inviato o meno all'utente invitato.

Proprietà dei parametri

Tipo:System.Boolean
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

None

Output

System.Object

Note