Functions/Public/content-management-service/Get-vRAPackage.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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
function Get-vRAPackage { <# .SYNOPSIS Retrieve vRA Packages .DESCRIPTION Retrieve vRA Packages .PARAMETER Id Specify the ID of a Package .PARAMETER Name Specify the Name of a Package .PARAMETER Limit The number of entries returned per page from the API. This has a default value of 100 .PARAMETER Page The index of the page to display. .INPUTS System.String System.Int .OUTPUTS System.Management.Automation.PSObject. .EXAMPLE Get-vRAPackage .EXAMPLE Get-vRAPackage -Id "b2d72c5d-775b-400c-8d79-b2483e321bae" .EXAMPLE Get-vRAPackage -Name "Package01","Package02" #> [CmdletBinding(DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject')] Param ( [Parameter(Mandatory=$true,ParameterSetName="ById")] [ValidateNotNullOrEmpty()] [String[]]$Id, [Parameter(Mandatory=$true,ParameterSetName="ByName")] [ValidateNotNullOrEmpty()] [String[]]$Name, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Int]$Page = 1, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Int]$Limit = 100 ) # --- Test for vRA API version xRequires -Version 7.0 try { switch ($PsCmdlet.ParameterSetName) { "ById" { foreach ($PackageId in $Id){ $URI = "/content-management-service/api/packages/$($PackageId)" # --- Run vRA REST Request $Package = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference [PSCustomobject]@{ Name = $Package.name Id = $Package.id Description = $Package.description TenantId = $Package.tenantId SubtenantId = $Package.subtenantId Contents = $Package.contents CreatedDate = $Package.createdDate LastUpdated = $Package.lastUpdated version = $Package.version } } break } "ByName" { foreach ($PackageName in $Name){ $URI = "/content-management-service/api/packages?`$filter=name eq '$($PackageName)'" $EscapedURI = [uri]::EscapeUriString($URI) # --- Run vRA REST Request $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference if (-not $Response.content){ throw "Unable to retrieve Package with Name $($Name)" } foreach ($Package in $Response.content){ [PSCustomobject]@{ Name = $Package.name Id = $Package.id Description = $Package.description TenantId = $Package.tenantId SubtenantId = $Package.subtenantId Contents = $Package.contents CreatedDate = $Package.createdDate LastUpdated = $Package.lastUpdated version = $Package.version } } } break } "Standard" { $URI = "/content-management-service/api/packages?limit=$($Limit)&page=$($Page)&`$orderby=name asc" $EscapedURI = [uri]::EscapeUriString($URI) $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference foreach ($Package in $Response.content){ [PSCustomobject]@{ Name = $Package.name Id = $Package.id Description = $Package.description TenantId = $Package.tenantId SubtenantId = $Package.subtenantId Contents = $Package.contents CreatedDate = $Package.createdDate LastUpdated = $Package.lastUpdated version = $Package.version } } Write-Verbose -Message "Total: $($Response.metadata.totalElements) | Page: $($Response.metadata.number) of $($Response.metadata.totalPages) | Size: $($Response.metadata.size)" break } } } catch [Exception]{ throw } } |