Get-BTProfile

NAME Get-BTProfile



SYNOPSIS

Returns Power365 Profiles.





SYNTAX

Get-BTProfile [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]



Get-BTProfile [-Filter <string>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]





DESCRIPTION

Get-BTProfile -Identity returns the Profile identified by its ProfileId, ProfileName, or a Profile object.



Get-BTProfile [-Project] [-Filter] [-Limit] returns Profiles matching selection criteria.



The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProfile cmdlet.





PARAMETERS

-Identity <object>

Profile identity: ProfileId, ProfileName, or Profile object.



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Project <object>

Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's

default Project, if any.



Required? false

Position? named

Default value System.Object

Accept pipeline input? false

Accept wildcard characters? false



-Filter <string>

Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties

are ProfileId, ProfileName, ProjectId, ProjectName, and LastUpdateUtc.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Limit <int>

Limit the number of returned items.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Session <Session>

The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.



Required? false

Position? named

Default value

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.Object

Profile identity: ProfileId, ProfileName, or Profile object.





OUTPUTS

BinaryTree.Power365.SDK.Profile





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



Get-BTProfile -Identity 986

Get-BTProfile -Identity 'My Profile'

Get-BTProfile -Identity $profile

Returns a Profile by ProfileId, ProfileName, or a Profile object.



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



Get-BTProfile

Returns all Profiles.



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



Get-BTProfile -Filter "ProfileName -like 'M*' -Limit 10

Returns the first 10 Profiles whose ProfileName begins with 'M'.





RELATED LINKS