Início rápido: adicionar um usuário convidado com o PowerShell

Aplica-se a: Locatários da força de trabalho (saiba mais)

Há muitas maneiras de convidar parceiros externos para seus aplicativos e serviços com a colaboração B2B do Microsoft Entra. No início rápido anterior, você viu como adicionar usuários convidados diretamente no centro de administração do Microsoft Entra. Também é possível usar o PowerShell para adicionar usuários convidados, um de cada vez ou em massa. Neste início rápido, você usará o comando New-MgInvitation para adicionar um usuário convidado ao locatário Microsoft Entra.

Este artigo explica como convidar usuários convidados com Microsoft Graph PowerShell. Você também pode gerenciar usuários convidados com Microsoft Entra PowerShell.

Pré-requisitos

Para concluir o cenário deste guia de início rápido, você precisa de:

• Uma assinatura Azure. Se você não tiver uma assinatura do Azure, crie uma conta gratuita antes de começar.
• Uma função que permite que você crie usuários em seu diretório de locatários, como uma função de pelo menos Convite de Convidado ou um Administrador de Usuários.
• Instale o módulo Microsoft Graph Identity Sign-ins (Microsoft. Graph.Identity.SignIns) e o módulo Microsoft Graph Users (Microsoft. Graph.Users). Você pode usar a instrução #Requires para impedir a execução de um script, a menos que os módulos necessários do PowerShell sejam atendidos.

#Requires -Modules Microsoft.Graph.Identity.SignIns, Microsoft.Graph.Users

• Obtenha uma conta de email de teste. É necessário ter uma conta de email de teste para enviar o convite. A conta precisa estar fora da organização. Você pode usar qualquer tipo de conta, incluindo uma conta social, como um endereço Gmail.com ou Outlook.com.

Entrar no locatário

Execute o seguinte comando para se conectar ao seu locatário:

Connect-MgGraph -Scopes 'User.Invite.All','User.Read.All'

Insira suas credenciais quando solicitado.

Enviar um convite

1. Para enviar um convite para a conta de email de teste, execute o seguinte comando do PowerShell (substitua "Henry Ross" e henry@contoso.com pelo nome da conta de email de teste e o endereço de email):

   New-MgInvitation -InvitedUserDisplayName "Henry Ross" -InvitedUserEmailAddress henry@contoso.com -InviteRedirectUrl "https://myapplications.microsoft.com" -SendInvitationMessage:$true
   

2. O comando enviará um convite para o endereço de email especificado. Verifique o resultado, que deverá ser semelhante ao exemplo seguinte:

   Id                                   InviteRedeemUrl                                                                                                   
   --                                   ---------------                                                                                                   
   00aa00aa-bb11-cc22-dd33-44ee44ee44ee https://login.microsoftonline.com/redeem?...
   

Verificar se o usuário existe no diretório

1. Para verificar se o usuário convidado foi adicionado ao Microsoft Entra ID, execute o seguinte comando (substitua henry@contoso.com pelo email convidado):

   Get-MgUser -Filter "Mail eq 'henry@contoso.com'"
   

2. Verifique a saída para confirmar se o usuário que você convidou está na lista com um nome UPN no formato endereçodeemail#EXT#@domínio. Por exemplo, henry_contoso.com#EXT#@fabrikam.onmicrosoft.com, em que fabrikam.onmicrosoft.com é a organização da qual você enviou os convites.

   Id                                   DisplayName              Mail                           UserPrincipalName        
   --                                   -----------              ----                           -----------------               
   00aa00aa-bb11-cc22-dd33-44ee44ee44ee Henry Ross               henry@contoso.com              henry_contoso.com#EXT#@fabrikam.onmicrosoft.com
   

Limpar os recursos

É possível excluir a conta de usuário de teste no diretório quando ela não for mais necessária. Execute o comando a seguir para excluir uma conta de usuário:

Remove-MgUser -UserId '<String>'

Por exemplo:

Remove-MgUser -UserId 'henry_contoso.com#EXT#@fabrikam.onmicrosoft.com'

Ou

Remove-MgUser -UserId '00aa00aa-bb11-cc22-dd33-44ee44ee44ee'

Próximas etapas

Neste início rápido, você convidou e adicionou um único usuário convidado ao diretório usando o PowerShell. Você também pode convidar um usuário convidado usando o centro de administração do Microsoft Entra. Além disso, você pode convidar usuários convidados em massa usando o PowerShell.