5.6 New-AzureDRAMSInvitation

Synopsis

Invites a new external user to Azure Active Directory.

Syntax

New-AzureDRAMSInvitation -InvitedUserDisplayName <String> -InvitedUserEmailAddress <String> -Tenant <String> [-InviteRedirectUrl <String>] [-InvitationMessage <String>] [-CCRecipients <String>] [-Properties <Hashtable>] [-DRARestServer <String>] [-DRARestPort <Int>] [-IgnoreCertificateErrors] [-Force] [-Timeout <Int>] [<CommonParameters>]

Description

The New-AzureDRAMSInvitation cmdlet sends an email to the external user’s email address specified in the InvitedUserEmailAddress parameter inviting the external user to Azure Active Directory. To run this command, you must have the Invite Azure Guest User power.

Parameters

Attribute / Description

Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

InvitedUserDisplayName [<String>]

The display name of the guest user as it appears in your Azure Active Directory.

true

named

true (ByPropertyName)

false

InvitedUserEmailAddress [<String>]

The email address of the guest user to which the invitation is sent.

true

named

 

true (ByPropertyName)

false

Tenant <String>

The Tenant ID of the object in GUID or displayname format.

For example: b201dhg8-087e-5n9d-9986-c4d987bfa0b1 or MyTenant

true

named

 

true (ByPropertyName)

false

CCRecipients [<String]

Additional recipient the invitation message should be sent to.

false

named

true (ByPropertyName)

false

InviteRedirectUrl <String>

The URL to which the guest user is redirected after accepting the invitation.

false

named

 

true (ByPropertyName)

false

InvitationMessage <String>

Welcome message text that is sent to the guest user. You can customize the message as needed if you do not want to use the default message.

false

named

 

true (ByPropertyName)

false

Properties <Hashtable>

A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value}

Multiple values are specified as a comma-separated list.For example: -Properties @{Attribute1DRADisplayName=value1, value2}

If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Properties @{"Attribute1-DRA-DisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Attribute1DRADisplayName="`"sample`" value"}

false

named

 

true (ByPropertyName)

false

DRARestServer [<String>]

The name of the computer running the DRA REST Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'.

false

named

true (ByPropertyName)

false

DRARestPort [<Int32>]

The port where the DRA REST Service listens for requests. This parameter is used only when the DRARestServer parameter is also specified. If the parameter is not specified, the value defaults to 8755.

false

named

8755

true (ByPropertyName)

false

IgnoreCertificateErrors [<SwitchParameter>]

Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate.

false

named

false

false

Force [<SwitchParameter>]

Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user.

false

named

false

false

Timeout [<Int32>]

The wait time in seconds before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1.

false

named

100 seconds

true (ByPropertyName)

false

<CommonParameters>

Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters.

 

 

 

 

 

NOTE:For more information, type "Get-Help New-AzureDRAMSInvitation -detailed". For technical information, type "Get-Help New-AzureDRAMSInvitation -full".

Example 5-15 1

PS C:\>New-AzureDRAMSInvitation -Tenant MyTenant -InvitedUserDisplayName "MyExternalUser" -InvitedUserEmailAddress "someexternaluser@externaldomain.com" -InviteRedirectUrl "http://myapps.microsoft.com" -Properties @{AllowSignOn=$true;}

This example invites an external user named MyExternalUser to your Azure Active Directory. An email is sent to the external user’s email address someexternaluser@externaldomain.com. When the user accepts the invitation, the user is redirected to the URL http://myapps.microsoft.com. The Azure guest user account will be created in the tenant named MyTenant.

Example 5-16 2

New-AzureDRAMSInvitation -Tenant MyTenant -InvitedUserDisplayName "MyExternalUser" -InvitedUserEmailAddress "someexternaluser@externaldomain.com"

If an earlier invitation is not accepted by the external user, you can resend the invitation. This example resends the invite to the external user named MyExternalUser. An email is sent to the external user’s email address someexternaluser@externaldomain.com.