Get-OctopusChannel

NAME Get-OctopusChannel



SYNOPSIS

Gets information about Octopus Channels





SYNTAX

Get-OctopusChannel [[-ChannelName] <string[]>] [[-ProjectName] <string[]>] [-ResourceOnly <SwitchParameter>]

[<CommonParameters>]





DESCRIPTION





PARAMETERS

-ChannelName <string[]>

Channel name



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <string[]>

Channel name



This is an alias of the ChannelName parameter.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ProjectName <string[]>

Project name



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Project <string[]>

Project name



This is an alias of the ProjectName parameter.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ResourceOnly <SwitchParameter>

If set to TRUE the cmdlet will return the basic Octopus resource. If not set or set to FALSE, the cmdlet will

return a human friendly Octoposh output object



Required? false

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

System.String[]

Channel name



System.String[]

Project name





OUTPUTS

System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusChannel, Octoposh, Version=1.0.0.0,

Culture=neutral, PublicKeyToken=null]]



System.Collections.Generic.List`1[[Octopus.Client.Model.ChannelResource, Octopus.Client, Version=4.22.0.0,

Culture=neutral, PublicKeyToken=null]]





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



PS C:\\> Get-OctopusChannel



Gets all the channels in all the projects of the instance

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



PS C:\\> Get-OctopusChannel -Project "MyFinantialApp"



Gets all the channels of the project "MyFinantialApp"

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



PS C:\\> Get-OctopusChannel -name "Hotfix_Website" -Project "MyFinantialApp"



Gets the Channel with the name "Hotfix_Website" of the project "MyFinantialApp"

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



PS C:\\> Get-OctopusChannel -name "Hotfix_Website","Hotfix_WebService" -Project "MyFinantialApp"



Gets the Channels with the names "Hotfix_Website" and "Hotfix_WebService" of the project "MyFinantialApp"

---------- EXAMPLE 5 ----------



PS C:\\> Get-OctopusChannel -name "Hotfix_*" -Project "MyFinantialApp"



Gets all the Channels whose name starts with "Hotfix_" of the project "MyFinantialApp"



RELATED LINKS

WebSite: http://Octoposh.net

Github Project: https://github.com/Dalmirog/OctoPosh/

Wiki: http://octoposh.readthedocs.io

QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial