Public/Delete-EdgeReference.ps1
|
# Copyright 2017-2018 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 Delete-EdgeReference { <# .SYNOPSIS Delete a reference from Apigee Edge. .DESCRIPTION Delete a reference from Apigee Edge. .PARAMETER Name Required. The name of the reference to delete. .PARAMETER Environment Required. The environment in which the reference is found. .PARAMETER Org Optional. The Apigee Edge organization. The default is to use the value from Set-EdgeConnection. .EXAMPLE Delete-EdgeReference -Name ref-2 -Environment test .LINK Create-EdgeKeystore .LINK Get-EdgeReference .LINK Get-EdgeKeystore .FUNCTIONALITY ApigeeEdge #> [cmdletbinding()] PARAM( [Parameter(Mandatory=$True)][string]$Name, [Parameter(Mandatory=$True)][string]$Environment, [string]$Org ) $Options = @{ } if ($PSBoundParameters['Debug']) { $DebugPreference = 'Continue' $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.Add( 'Collection', $(Join-Parts -Separator "/" -Parts 'e', $Environment, 'references' ) ) $Options.Add( 'Name', $Name ) Write-Debug ([string]::Format("Options {0}`n", $(ConvertTo-Json $Options -Compress ) ) ) Delete-EdgeObject @Options } |