Functions/Public/catalog-service/Set-vRACatalogItem.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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
function Set-vRACatalogItem { <# .SYNOPSIS Update a vRA catalog item .DESCRIPTION Update a vRA catalog item .PARAMETER Id The id of the catalog item .PARAMETER Status The status of the catalog item (e.g. PUBLISHED, RETIRED, STAGING) .PARAMETER Quota The Quota of the catalog item .PARAMETER Service The Service to assign the catalog item to .PARAMETER NewAndNoteworthy Mark the catalog item as New and noteworthy in the UI .PARAMETER IconId The Icon Id of the catalog item. This must already exist in the Service Catalog. Typically it would have already been created via Import-vRAServiceIcon .INPUTS System.Int System.String System.Bool .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Set-vRACatalogItem -Id dab4e578-57c5-4a30-b3b7-2a5cefa52e9e -Status PUBLISHED .EXAMPLE Set-vRACatalogItem -Id dab4e578-57c5-4a30-b3b7-2a5cefa52e9e -Quota 1 .EXAMPLE Set-vRACatalogItem -Id dab4e578-57c5-4a30-b3b7-2a5cefa52e9e -Service "Default Service" .EXAMPLE Set-vRACatalogItem -Id dab4e578-57c5-4a30-b3b7-2a5cefa52e9e -NewAndNoteworthy $false .EXAMPLE Get-vRACatalogItem -Name "Create cluster" | Set-vRACatalogItem -IconId "cafe_icon_CatalogItem01" -Confirm:$false TODO: - Investigate / fix authorization error #> [CmdletBinding(SupportsShouldProcess,ConfirmImpact="High",DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject')] Param ( [Parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Mandatory=$false,ParameterSetName="SetStatus")] [ValidateSet("PUBLISHED","RETIRED","STAGING")] [String]$Status, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Quota, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [String]$Service, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Bool]$NewAndNoteworthy, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$IconId ) Begin { # --- Test for vRA API version xRequires -Version 7.0 } Process { # --- Check for existing catalog item try { Write-Verbose -Message "Testing for existing catalog item" #$CatalogItem = Get-vRACatalogItem -Id $($Id) $URI = "/catalog-service/api/catalogItems/$($Id)" $CatalogItem = Invoke-vRARestMethod -Method GET -URI $URI } catch [Exception] { throw } if ($PSBoundParameters.ContainsKey("Status")){ Write-Verbose -Message "Updating Status: $($CatalogItem.status) >> $($Status)" $CatalogItem.status = $Status } if ($PSBoundParameters.ContainsKey("Quota")){ Write-Verbose -Message "Updating Quota: $($CatalogItem.quota) >> $($Quota)" $CatalogItem.quota = $Quota } if ($PSBoundParameters.ContainsKey("Service")){ $NewService = Get-vRAService -Name $($Service) # --- If the catalog item does not currently have service assigned, add one if (-not($CatalogItem.serviceRef)) { Write-Verbose -Message "Associating catalog item with service $($Service)" $ServiceRef = [PSCustomObject] @{ id = $NewService.Id; name = $NewService.Name; } $CatalogItem | Add-Member -MemberType NoteProperty -Name "serviceRef" -Value $ServiceRef -Force } else { Write-Verbose -Message "Updating Service >> $($Service)" $CatalogItem.serviceRef.id = $NewService.Id $CatalogItem.serviceRef.label = $NewService.Name } } if ($PSBoundParameters.ContainsKey("NewAndNoteworthy")){ Write-Verbose -Message "Updating isNoteworthy: $($CatalogItem.isNoteworthy) >> $($NewAndNoteworthy)" $CatalogItem.isNoteworthy = $NewAndNoteworthy } if ($PSBoundParameters.ContainsKey("IconId")){ Write-Verbose -Message "Updating IconId: $($CatalogItem.iconId) >> $($IconId)" $CatalogItem.iconId = $IconId } # --- Update the existing catalog item try { if ($PSCmdlet.ShouldProcess($Id)){ # --- Build the URI string for the catalog item $URI = "/catalog-service/api/catalogItems/$($Id)" Invoke-vRARestMethod -Method PUT -URI $URI -Body ($CatalogItem | ConvertTo-Json -Depth 100) -Verbose:$VerbosePreference | Out-Null Get-vRACatalogItem -Id $($CatalogItem.id) } } catch [Exception] { throw } } End { } } |