Public/Get-ArmorCompleteDatacenter.ps1
|
function Get-ArmorCompleteDatacenter { <# .SYNOPSIS This cmdlet retrieves Armor Complete datacenters. .DESCRIPTION This cmdlet retrieves details about the Armor Complete datacenters, regions, and compute zones. Returns a set of datacenters that correspond to the filter criteria provided by the cmdlet parameters. .INPUTS System.UInt16 System.String .NOTES Troy Lindsay Twitter: @troylindsay42 GitHub: tlindsay42 .EXAMPLE Get-ArmorCompleteDatacenter | Select-Object -Property ID, Location, Name ID Location Name -- -------- ---- 1 DFW01 US Central 2 PHX01 US West 3 LHR01 EU West 4 AMS01 EU Central 5 SIN01 AS East Description ----------- Gets the Armor Complete datacenters and filters the compute zones. .EXAMPLE Get-ArmorCompleteDatacenter -ID 2 | Select-Object -Property ID, Location, Name ID Location Name -- -------- ---- 2 PHX01 US West Description ----------- Gets the Armor Complete datacenter with ID=2 and filters the compute zones. .EXAMPLE 1, 'PHX01' | Get-ArmorCompleteDatacenter | Select-Object -Property ID, Location, Name ID Location Name -- -------- ---- 1 DFW01 US Central 2 PHX01 US West Description ----------- Gets the Armor Complete datacenter with ID=1 and Location='PHX01' and filters the compute zones. .LINK http://armorpowershell.readthedocs.io/en/latest/cmd_get.html#get-armorcompletedatacenter .LINK https://github.com/tlindsay42/ArmorPowerShell .LINK https://docs.armor.com/display/KBSS/Get+Locations .LINK https://developer.armor.com/#!/Infrastructure/Location_Get #> [CmdletBinding( DefaultParameterSetName = 'ID' )] [OutputType( [ArmorCompleteDatacenter[]] )] param ( <# Specifies the ID of the Armor Complete datacenter. #> [Parameter( ParameterSetName = 'ID', Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [ValidateSet( 1, 2, 3, 4, 5 )] [UInt16] $ID = 0, <# Specifies the name of the Armor Complete region. #> [Parameter( ParameterSetName = 'Name', ValueFromPipelineByPropertyName = $true )] [ValidateSet( 'AS East', 'EU Central', 'EU West', 'US Central', 'US West' )] [String] $Name = '', <# Specifies the name of the Armor Complete datacenter. #> [Parameter( ParameterSetName = 'Location', Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [ValidateSet( 'AMS01', 'DFW01', 'LHR01', 'PHX01', 'SIN01' )] [String] $Location = '', <# Specifies the API version for this request. #> [Parameter( Position = 1 )] [ValidateSet( 'v1.0' )] [String] $ApiVersion = $Global:ArmorSession.ApiVersion ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message "Beginning: '${function}'." Test-ArmorSession } # End of begin process { [ArmorCompleteDatacenter[]] $return = $null $resources = Get-ArmorApiData -FunctionName $function -ApiVersion $ApiVersion $uri = New-ArmorApiUri -Endpoints $resources.Endpoints $keys = ( $resources.Query | Get-Member -MemberType 'NoteProperty' ).Name $parameters = ( Get-Command -Name $function ).Parameters.Values $uri = New-ArmorApiUriQuery -Keys $keys -Parameters $parameters -Uri $uri $results = Submit-ArmorApiRequest -Uri $uri -Method $resources.Method -Description $resources.Description $filters = ( $resources.Filter | Get-Member -MemberType 'NoteProperty' ).Name $results = Select-ArmorApiResult -Results $results -Filters $filters if ( $results.Count -eq 0 ) { Write-Host -Object 'Armor Complete datacenter not found.' } else { $return = $results } $return } # End of process end { Write-Verbose -Message "Ending: '${function}'." } # End of end } # End of function |