4.2 New-AzureDRAContact

Synopsis

Creates a contact in Azure Active Directory.

Syntax

New-AzureDRAContact -Tenant <String> -Properties <Hashtable> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The New-AzureDRAContact cmdlet creates a contact in Azure Active Directory. The requesting user must have the Create Azure Contact and Modify All Properties power or a custom power with the necessary powers for the requested attributes. Use the Properties parameter to specify the values to use when creating the Azure contact.

Parameters

Attribute / Description

Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

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"}

true

named

 

true (ByPropertyName)

false

Tenant <String>

The Tenant ID of the object in GUID or display name format.

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

true

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-AzureDRAContact -detailed". For technical information, type "Get-Help New-AzureDRAContact -full".

Example 4-4 1

PS C:\>New-AzureDRAContact -Tenant MyTenant -Properties @{Name="MyContact";Mail="mycontact@Mycompany.corp";MailNickName="mycontact"};

This example creates an Azure contact named MyContact in Azure Active Directory using the Name property. The Azure contact will be created in the tenant MyTenant. There are two properties set on this Azure contact.

Example 4-5 2

PS C:\>New-AzureDRAContact -Tenant MyTenant -Properties   @{FirstName="My";LastName="Contact1";Name="MyContact1";DisplayName="My   Contact1";Mail="mycontact1@Mycompany.corp";MailNickName="mycontact1"};

This example creates an Azure contact named MyContact in Azure Active Directory using the Name property. The Azure contact will be created in the tenant MyTenant. There are five properties set on this Azure contact.