Functions/Public/component-registry/Get-vRAComponentRegistryService.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 |
function Get-vRAComponentRegistryService { <# .SYNOPSIS Get information about vRA services .DESCRIPTION Get information about vRA services. .PARAMETER Id The Id of the service. Specifying the Id of the service will retrieve detailed information. .PARAMETER Name The name of the service .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 System.Management.Automation.SwitchParameter .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Get-vRAComponentRegistryService .EXAMPLE Get-vRAComponentRegistryService -Limit 9999 .EXAMPLE Get-vRAComponentRegistryService -Page 1 .EXAMPLE Get-vRAComponentRegistryService -Id xxxxxxxxxxxxxxxxxxxxxxxx .EXAMPLE Get-vRAComponentRegistryService -Name "iaas-service" #> [CmdletBinding(DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject')] Param ( [parameter(Mandatory=$true, ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true, ParameterSetName="ById")] [ValidateNotNullOrEmpty()] [String[]]$Id, [parameter(Mandatory=$true, ParameterSetName="ByName")] [ValidateNotNullOrEmpty()] [String[]]$Name, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Page = 1, [parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Limit = 100 ) Begin { $BaseURI = "/component-registry/services" } Process { try { switch($PSCmdlet.ParameterSetName) { 'ById'{ foreach ($ServiceId in $Id) { $URI = "$($BaseURI)/$($ServiceId)" $Service = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference [PSCustomObject] @{ Id = $Service.id Name = $Service.name CreatedDate = $Service.createdDate LastUpdated = $Service.lastUpdated OwnerId = $Service.ownerId ServiceVersion = $Service.serviceVersion ServiceAttributes = $Service.serviceAttributes EndPoints = $Service.endPoints ServiceType = $Service.serviceType NameMsgKey = $Service.nameMsgKey } } break } 'ByName' { foreach ($ServiceName in $Name) { $URI = "$($BaseURI)?`$filter=name eq '$($ServiceName)'" $EscapedURI = [uri]::EscapeUriString($URI) $Service = (Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference).content if ($Service.Length -eq 0) { throw "Could not find service with name $($ServiceName)" } [PSCustomObject] @{ Id = $Service.id Name = $Service.name CreatedDate = $Service.createdDate LastUpdated = $Service.lastUpdated OwnerId = $Service.ownerId ServiceVersion = $Service.serviceVersion ServiceAttributes = $Service.serviceAttributes EndPoints = $Service.endPoints ServiceType = $Service.serviceType NameMsgKey = $Service.nameMsgKey } } break } 'Standard' { # --- Build up the URI string depending on switch $URI = "$($BaseURI)?limit=$($Limit)&page=$($Page)&`$orderby=name asc" $Response = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference foreach ($Service in $Response.content) { [PSCustomObject] @{ Id = $Service.id Name = $Service.name CreatedDate = $Service.createdDate LastUpdated = $Service.lastUpdated OwnerId = $Service.ownerId ServiceVersion = $Service.serviceVersion ServiceAttributes = $Service.serviceAttributes EndPoints = $Service.endPoints ServiceType = $Service.serviceType NameMsgKey = $Service.nameMsgKey } } Write-Verbose -Message "Total: $($Response.metadata.totalElements) | Page: $($Response.metadata.number) of $($Response.metadata.totalPages) | Size: $($Response.metadata.size)" break } } } catch [Exception]{ throw } } } |