Updates a specific group in Azure Active Directory.
Set-AzureDRAGroup -Tenant <String> -Properties <Hashtable> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Set-AzureDRAGroup cmdlet updates a group in Azure Active Directory. The requesting user must have the Modify All Azure Group Properties or a custom power with the necessary powers for the requested attributes.
|
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 |
|
Identifier <String> The GUID of the Azure group. For example: 3FB3B182-FAA2-476A-9843-5F77B245DD03 |
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 |
|
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-AzureDRAGroup -detailed". For technical information, type "Get-Help Set-AzureDRAGroup -full".
Example 3-19 1
PS C:\>Set-AzureDRAGroup -Tenant MyTenant -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Properties @{Description="Test description";GroupOwnersAdd="CN=a89cc7f6-1e9f-41fc-9715-f3e27fb1f4cb,az=MyTenant"}
This example updates the description property and the owner of the group 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1.
Example 3-20 2
PS C:\>Set-AzureDRAGroup -Tenant MyTenant -Identifier 57333c17-6761-4cde-9e66-ad32b7a240e9 -Properties @{GroupOwnersAdd="CN=24fdbef7-717e-4449-b840-75df0a89cf2c,az=MyTenant", "CN=My User,DC=MyDomain,DC=COM "}
-DRARestServer localhost -DRARestPort 9000 -IgnoreCertificateErrors -Force
This example adds Azure objects and synced objects to the group while updating the group.