Get-LinaTenant

NAME Get-LinaTenant



SYNOPSIS

Retrieves the tenants (entities) on a Lina server.





SYNTAX

Get-LinaTenant [[-Name] <String>] [<CommonParameters>]



Get-LinaTenant -ID <Int32> [<CommonParameters>]



Get-LinaTenant -Default [<CommonParameters>]





DESCRIPTION

Retrieves the tenants (entities) on a Lina server. Returns a set of tenants that correspond to the filter criteria

provided.





PARAMETERS

-Name <String>

Optional : Name of the tenant to retrieve. Wilcards are allowed. For example : *Tenant*



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <Int32>

Optional : ID of the tenant to retrieve.



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Default [<SwitchParameter>]

Get the default tenant if any



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None





OUTPUTS

Array of LinaTenant Objects





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-LinaTenant



Retrieve all tenants









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-LinaTenant -Name "BaasCustomer1"



Retrieve Tenant named BaasCustomer1









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-LinaTenant -ID 2



Retrieve Tenant with ID 2









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-LinaTenant -Default



Retrieve the default tenant (if any)











RELATED LINKS