Get-OctopusUserRole

NAME Get-OctopusUserRole



SYNOPSIS

This cmdlet returns information about Octopus UserRoles





SYNTAX

Get-OctopusUserRole [[-UserRoleName] <string[]>] [<CommonParameters>]





DESCRIPTION

This cmdlet returns information about Octopus UserRoles





PARAMETERS

-UserRoleName <string[]>

User role name



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <string[]>

User role name



This is an alias of the UserRoleName parameter.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

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[]

User role name





OUTPUTS

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

Culture=neutral, PublicKeyToken=null]]





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



PS C:\\> Get-OctopusUserRole



Get all the UserRoles of the current Instance

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



PS C:\\> Get-OctopusUserRole -name "App1_ReleaseCreators"



Get the User Role named "App1_ReleaseCreators"

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



PS C:\\> Get-OctopusUserRole -name "App1_Deployers","App2_Deployers"



Gets the User Roles with the names "App1_Deployers" and "App2_Deployers"

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



PS C:\\> Get-OctopusUserRole -name "*_Administrators"



Gets all the User Roles whose name ends with "_Administrators*"



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