Functions/Public/identity/Get-vRATenant.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 |
function Get-vRATenant { <# .SYNOPSIS Retrieve vRA Tenants .DESCRIPTION Retrieve vRA Tenants. Make sure to have permission to access all Tenant information .PARAMETER Id Specify the ID of a Tenant .PARAMETER Limit The number of entries returned per page from the API. This has a default value of 100. .INPUTS System.String .OUTPUTS System.Management.Automation.PSObject. .EXAMPLE Get-vRATenant .EXAMPLE Get-vRATenant -Id Tenant01 #> [CmdletBinding()][OutputType('System.Management.Automation.PSObject')] Param ( [parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Alias("Name")] [String[]]$Id, [parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Limit = "100" ) try { # --- If the Id parameter is passed return only that Tenant if ($PSBoundParameters.ContainsKey("Id")){ foreach ($TenantId in $Id){ $URI = "/identity/api/tenants/$($TenantId)" # --- Run vRA REST Request $Response = Invoke-vRARestMethod -Method GET -URI $URI [pscustomobject]@{ Id = $Response.id UrlName = $Response.urlName Name = $Response.name Description = $Response.description ContactEmail = $Response.contactEmail Password = $Response.password DefaultTenant = $Response.defaultTenant } } } else { $URI = "/identity/api/tenants?limit=$($Limit)" # --- Run vRA REST Request $Response = Invoke-vRARestMethod -Method GET -URI $URI foreach ($Tenant in $Response.content) { [pscustomobject]@{ Id = $Tenant.id UrlName = $Tenant.urlName Name = $Tenant.name Description = $Tenant.description ContactEmail = $Tenant.contactEmail Password = $Tenant.password DefaultTenant = $Tenant.defaultTenant } } } } catch [Exception]{ throw } } |