4.4 Set-AzureDRAContact

Synopsis

Updates a contact in Azure Active Directory.

Syntax

Set-AzureDRAContact -Tenant <String> [-Properties <Hashtable>] [-Replace <Hashtable>] [-Add <Hashtable>] [-Remove <Hashtable>] [-Clear <String[]>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Set-AzureDRAContact cmdlet updates a contact in Azure Active Directory. The requesting user must have the Modify All Azure Contact Properties power or a custom power with the necessary powers for the requested attributes.

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

Replace [<Hashtable>]

A Hashtable of property values to replace the current set of values for the specified property.

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

Multiple values are specified as a comma-separated list and will replace currently set values.For example: -Replace @{Attribute1DRADisplayName=value1, value2}

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

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

false

named

 

true (ByPropertyName)

false

Add [<Hashtable>]

A Hashtable of property values to add to the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface.

For example: -Add @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2}

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

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

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

false

named

 

true (ByPropertyName)

false

Remove [<Hashtable>]

A Hashtable of property values to remove from the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface.

For example: -Remove @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2}

Multiple values are specified as a comma-separated list and will be removed from currently set values.For example: -Remove @{Attribute1DRADisplayName=value1,value2}

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

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

false

named

 

true (ByPropertyName)

false

Clear [<String>]

An array of property names whose values will be cleared. Each name is the name of a defined property in the REST interface.

For example: -Clear "Attribute1-DRA-DisplayName"

Multiple values need to be separated by a comma.

For example: -Clear Attribute1DRADisplayName, Attribute2DRADisplayName

false

named

 

true (ByPropertyName)

false

Identifier <String>

The GUID or display name of the Azure contact.

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

Example 4-7 1

PS C:\>Set-AzureDRAContact -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Properties @{Company="MyCompany";Department="Sales"}

This example updates the Company and Department properties of the Azure contact identified by the 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in the tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the Azure contact.

Example 4-8 2

PS C:\>Set-AzureDRAContact -Tenant MyTenant -Identifier Contact123 -Properties @{AcceptMessagesOnlyFromSendersOrMembers="CN=24fdbef7-717e-4449-b840-75df0a89cf2c,AZ=MyTenant";City="Houston"}";

This example updates the AcceptMessagesOnlyFromSendersOrMembers and City properties of the contact Contact123 in the tenant MyTenant. The identifier contains the GUID for the Azure contact. When the identifier format is the name, DRA resolves the name to the full distinguished name and then the update request is sent.