Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Set-GARole

SYNOPSIS

Updates a role. This method supports patch semantics.

SYNTAX

Set-GARole [[-Customer] <String>] [-RoleId] <String> [[-RoleBody] <Role>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Updates a role. This method supports patch semantics.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Set-GARole -Customer $SomeCustomerString -RoleId $SomeRoleIdString -RoleBody $SomeRoleObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-Customer

Immutable ID of the Google Apps account.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RoleId

Immutable ID of the role.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RoleBody

JSON template for role resource in Directory API.

Type: Role
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

Immutable ID of the Google Apps account.

System.String

Immutable ID of the role.

Google.Apis.admin.Directory.directory_v1.Data.Role

JSON template for role resource in Directory API.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Directory API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally