< Back
Get-MgaExchCategory
Post
NAME Get-MgaExchCategory
SYNOPSIS
Retrieves categories in Exchange Online using the graph api.
SYNTAX
Get-MgaExchCategory [-User <String>] [-ResultSize <Int64>] [-Token <AzureAccessToken>] [<CommonParameters>]
Get-MgaExchCategory [-InputObject] <CategoryParameter[]> [-User <String>] [-ResultSize <Int64>] [-Token
<AzureAccessToken>] [<CommonParameters>]
Get-MgaExchCategory [-Id] <Guid[]> [-User <String>] [-ResultSize <Int64>] [-Token <AzureAccessToken>]
[<CommonParameters>]
Get-MgaExchCategory [-Name] <String[]> [-User <String>] [-ResultSize <Int64>] [-Token <AzureAccessToken>]
[<CommonParameters>]
Get-MgaExchCategory [-Color] {NoColorMapped | Red | Orange | Brown | Yellow | Green | Teal | Olive | Blue | Purple
| Cranberry | Steel | DarkSteel | Gray | DarkGray | Black | DarkRed | DarkOrange | DarkBrown | DarkYellow |
DarkGreen | DarkTeal | DarkOlive | DarkBlue | DarkPurple | DarkCranberry} [-User <String>] [-ResultSize <Int64>]
[-Token <AzureAccessToken>] [<CommonParameters>]
DESCRIPTION
Retrieves categories in Exchange Online using the graph api.
PARAMETERS
-InputObject <CategoryParameter[]>
Carrier object for Pipeline input.Accepts CategoryObjects and strings.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Id <Guid[]>
The Id to filter by.
(Client Side filtering)
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
The name to filter by.
(Client Side filtering)
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color
The color to filter by.
(Client Side filtering)
Tab completion is available on this parameter for the list of the 25 predefined colors.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-User <String>
The user-account to access. Defaults to the main user connected as.
Can be any primary email name of any user the connected token has access to.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResultSize <Int64>
The user to execute this under. Defaults to the user the token belongs to.
Required? false
Position? named
Default value (Get-PSFConfigValue -FullName 'MSGraph.Query.ResultSize' -Fallback 100)
Accept pipeline input? false
Accept wildcard characters? false
-Token <AzureAccessToken>
The token representing an established connection to the Microsoft Graph Api.
Can be created by using New-MgaAccessToken.
Can be omitted if a connection has been registered using the -Register parameter on New-MgaAccessToken.
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
OUTPUTS
MSGraph.Exchange.Category.OutlookCategory
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-MgaExchCategory
Return all categories of the user connected to through a token.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-MgaExchCategory -Id "89101089-690d-4263-9470-b674e709a996"
Return the category with the specified Id of the user connected to through a token.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-MgaExchCategory -Name "*category"
Return all categories with names like "*category" of the user connected to through a token.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-MgaExchCategory -Color "Blue"
Return all categories with names like "*category" of the user connected to through a token.
RELATED LINKS
SYNOPSIS
Retrieves categories in Exchange Online using the graph api.
SYNTAX
Get-MgaExchCategory [-User <String>] [-ResultSize <Int64>] [-Token <AzureAccessToken>] [<CommonParameters>]
Get-MgaExchCategory [-InputObject] <CategoryParameter[]> [-User <String>] [-ResultSize <Int64>] [-Token
<AzureAccessToken>] [<CommonParameters>]
Get-MgaExchCategory [-Id] <Guid[]> [-User <String>] [-ResultSize <Int64>] [-Token <AzureAccessToken>]
[<CommonParameters>]
Get-MgaExchCategory [-Name] <String[]> [-User <String>] [-ResultSize <Int64>] [-Token <AzureAccessToken>]
[<CommonParameters>]
Get-MgaExchCategory [-Color] {NoColorMapped | Red | Orange | Brown | Yellow | Green | Teal | Olive | Blue | Purple
| Cranberry | Steel | DarkSteel | Gray | DarkGray | Black | DarkRed | DarkOrange | DarkBrown | DarkYellow |
DarkGreen | DarkTeal | DarkOlive | DarkBlue | DarkPurple | DarkCranberry} [-User <String>] [-ResultSize <Int64>]
[-Token <AzureAccessToken>] [<CommonParameters>]
DESCRIPTION
Retrieves categories in Exchange Online using the graph api.
PARAMETERS
-InputObject <CategoryParameter[]>
Carrier object for Pipeline input.Accepts CategoryObjects and strings.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Id <Guid[]>
The Id to filter by.
(Client Side filtering)
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
The name to filter by.
(Client Side filtering)
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color
The color to filter by.
(Client Side filtering)
Tab completion is available on this parameter for the list of the 25 predefined colors.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-User <String>
The user-account to access. Defaults to the main user connected as.
Can be any primary email name of any user the connected token has access to.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResultSize <Int64>
The user to execute this under. Defaults to the user the token belongs to.
Required? false
Position? named
Default value (Get-PSFConfigValue -FullName 'MSGraph.Query.ResultSize' -Fallback 100)
Accept pipeline input? false
Accept wildcard characters? false
-Token <AzureAccessToken>
The token representing an established connection to the Microsoft Graph Api.
Can be created by using New-MgaAccessToken.
Can be omitted if a connection has been registered using the -Register parameter on New-MgaAccessToken.
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
OUTPUTS
MSGraph.Exchange.Category.OutlookCategory
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-MgaExchCategory
Return all categories of the user connected to through a token.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-MgaExchCategory -Id "89101089-690d-4263-9470-b674e709a996"
Return the category with the specified Id of the user connected to through a token.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-MgaExchCategory -Name "*category"
Return all categories with names like "*category" of the user connected to through a token.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-MgaExchCategory -Color "Blue"
Return all categories with names like "*category" of the user connected to through a token.
RELATED LINKS