Public/Update-EdgeDeveloper.ps1
|
# Copyright 2017 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. Function Update-EdgeDeveloper { <# .SYNOPSIS Update a developer in Apigee Edge. .DESCRIPTION Update a Developer in Apigee Edge. When invoking this cmdlet you need to specify the firstname, last name, email, and username, at a minimum. You may also specify attributes. .PARAMETER Name The user name of the Developer. .PARAMETER Email The Email address of the developer to update. .PARAMETER First The first (given) name of the developer to update. .PARAMETER Last The last (sur-) name of the developer to update. .PARAMETER Attributes Optional. Hashtable specifying custom attributes for the developer. These will overwrite the existing attributes. .PARAMETER Org The Apigee Edge organization. The default is to use the value from Set-EdgeConnection. .EXAMPLE Update-EdgeDeveloper -Name 'DC' -First Dino -Last Chiesa -Email dchiesa@example.org -Attributes @{ 'shoesize' = 9 } .FUNCTIONALITY ApigeeEdge #> [cmdletbinding()] PARAM( [Parameter(Mandatory=$True)][string]$Name, [Parameter(Mandatory=$True)][string]$Email, [Parameter(Mandatory=$True)][string]$First, [Parameter(Mandatory=$True)][string]$Last, [hashtable]$Attributes, [string]$Org ) $Options = @{ Collection = 'developers' } if ($PSBoundParameters['Debug']) { $Options.Add( 'Debug', $Debug ) } if ($PSBoundParameters['Org']) { $Options.Add( 'Org', $Org ) } if (!$PSBoundParameters['Email']) { throw [System.ArgumentNullException] "Email", "You must specify the -Email option." } if (!$PSBoundParameters['First']) { throw [System.ArgumentNullException] "First", "You must specify the -First option." } if (!$PSBoundParameters['Last']) { throw [System.ArgumentNullException] "Last", "You must specify the -Last option." } if (!$PSBoundParameters['Name']) { throw [System.ArgumentNullException] "Name", "You must specify the -Name option." } $Options.Add( 'Name', $Email ) $Payload = @{ email = $Email userName = $Name firstName = $First lastName = $Last } if ($PSBoundParameters['Attributes']) { $a = @(ConvertFrom-HashtableToAttrList -Values $Attributes) $Payload.Add('attributes', $a ) } $Options.Add( 'Payload', $Payload ) Send-EdgeRequest @Options } |