Public/Create-EdgeCache.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 Create-EdgeCache { <# .SYNOPSIS Create a named cache in Apigee Edge. .DESCRIPTION Create a named cache in Apigee Edge. .PARAMETER Name The name of the cache to create. It must be unique for the environment. .PARAMETER Environment A string, the name of the environment for this cache. .PARAMETER Expiry The default expiry for items placed into the cache. This can be an integer, which is interpreted as seconds. For example 86400 is one day. Or, it can be a string, such as 600s, 45m, 10h, or 4d, which is intepreted as the intended number of seconds, minutes, hours, or days. Defaults to 86400. .PARAMETER Description A string, describing the purpose of the cache to be created. .PARAMETER Distributed Whether the cache will be distributed. Defaults to false. .PARAMETER OtherAttributes Optional. A hashtable specifying other attributes for the cache. .PARAMETER Org The Apigee Edge organization. The default is to use the value from Set-EdgeConnection. .EXAMPLE Create-EdgeCache -Name cache103 -Environment test -Expiry 30m -Distributed .FUNCTIONALITY ApigeeEdge #> [cmdletbinding()] PARAM( [Parameter(Mandatory=$True)][string]$Name, [Parameter(Mandatory=$True)][string]$Environment, [string]$Expiry = '86400', [string]$Description = 'a general purpose cache', [switch]$Distributed, [hashtable]$OtherAttributes, [string]$Org ) $Options = @{ } if ($PSBoundParameters['Debug']) { $Options.Add( 'Debug', $Debug ) } if ($PSBoundParameters['Org']) { $Options.Add( 'Org', $Org ) } if (!$PSBoundParameters['Name']) { throw [System.ArgumentNullException] "Name", "You must specify the -Name option." } if (!$PSBoundParameters['Environment']) { throw [System.ArgumentNullException] "Environment", "You must specify the -Environment option." } $Options['Collection'] = $( Join-Parts -Separator '/' -Parts 'e', $Environment, 'caches' ) $Options['QParams'] = $( ConvertFrom-HashtableToQueryString @{ name = $Name } ) $Payload = @{ description = $Description distributed = if ($Distributed) {'true'} else {'false'} expirySettings = @{ timeoutInSec = @{ value = $(Resolve-Expiry $Expiry)/1000 } valuesNull = 'false' } } $CacheAttrs= @{ compression = @{ minimumSizeInKB = 1024 } persistent = 'false' skipCacheIfElementSizeInKBExceeds = 2048 diskSizeInMB = 0 overflowToDisk = 'false' maxElementsOnDisk = 1 maxElementsInMemory = 3000000 inMemorySizeInKB = 8000 } if ($PSBoundParameters['OtherAttributes']) { $OtherAttributes.getEnumerator() | Foreach-Object { if( ! $CacheAttrs.ContainsKey($_.Key)) { $CacheAttrs[$_.Key] = $_.Value } } } $CacheAttrs.getEnumerator() | Foreach-Object { $Payload[$_.Key] = $_.Value } $Options.Add( 'Payload', $Payload ) Send-EdgeRequest @Options } |