Summary

Gets information about Octopus Tenants

Parameters

Name DataType Description
TenantName String[] Tenant name
ResourceOnly Switch If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object

Syntax


Get-OctopusTenant [[-TenantName] <string[]>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]




Examples

EXAMPLE 1

Gets all the tenants of the instance

 Get-OctopusTenant

EXAMPLE 2

Gets the tenant with the name "MyAwesometenant"

 Get-OctopusTenant -name "MyAwesomeTenant"

EXAMPLE 3

Gets the tenants with the names "MyAwesomeTenant" and "MyOtherAwesomeTenant"

 Get-OctopusTenant -name "MyAwesomeTenant","MyOtherAwesomeTenant"

EXAMPLE 4

Gets all the tenants whose name matches the pattern "*AwesomeTenant"

 Get-Channel -name "*AwesomeTenant"