Functions/Platforms/Get-PASPlatform.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
function Get-PASPlatform {
    <#
    .SYNOPSIS
    Retrieves details of a specified platform from the Vault.

    .DESCRIPTION
    Retrieves details of a specified platform from the Vault.

    .PARAMETER Name
    The unique ID/Name of the platform.

    .EXAMPLE
    Get-PASPlatform -Name "CyberArk"

    .NOTES
    Minimum CyberArk version 9.10
    #>


    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$Name
    )

    BEGIN {
        $MinimumVersion = [System.Version]"9.10"
    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create request URL
        $URI = "$Script:BaseURI/API/Platforms/$($Name | Get-EscapedString)"

        #Send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        If ($result) {

            #Return Results
            $result |

            Add-ObjectDetail -typename psPAS.CyberArk.Vault.Platform

        }

    }#process

    END { }#end

}