< Back

Invoke-MgaRestMethodGet

Sat Jan 18, 2020 4:41 pm

NAME Invoke-MgaRestMethodGet



SYNOPSIS

Performs a rest GET against the graph API





SYNTAX

Invoke-MgaRestMethodGet [-Field <String>] [-User <String>] [-Delta] [-ResultSize <Int64>] [-ApiConnection

<String>] [-ApiVersion <String>] [-Token <AzureAccessToken>] [-FunctionName <String>] [<CommonParameters>]



Invoke-MgaRestMethodGet [-Field <String>] [-User <String>] [-DeltaLink <String>] [-ResultSize <Int64>]

[-ApiConnection <String>] [-ApiVersion <String>] [-Token <AzureAccessToken>] [-FunctionName <String>]

[<CommonParameters>]





DESCRIPTION

Performs a rest GET against the graph API.

Primarily used for internal commands.





PARAMETERS

-Field <String>

The api child item under the username in the url of the api call.

If this didn't make sense to you, you probably shouldn't be using this command ;)



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-User <String>

The user to execute this under. Defaults to the user the token belongs to.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Delta [<SwitchParameter>]

Indicates that the query is intend to be a delta query, so a delta-link property is added to the output-object

('@odata.deltaLink').



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-DeltaLink <String>

Specifies the uri to query for delta objects on a query.



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



-ApiConnection <String>

The URI for the Microsoft Graph connection



Required? false

Position? named

Default value (Get-PSFConfigValue -FullName 'MSGraph.Tenant.ApiConnection' -Fallback

'https://graph.microsoft.com')

Accept pipeline input? false

Accept wildcard characters? false



-ApiVersion <String>

The version used for queries in Microsoft Graph connection



Required? false

Position? named

Default value (Get-PSFConfigValue -FullName 'MSGraph.Tenant.ApiVersion' -Fallback 'v1.0')

Accept pipeline input? false

Accept wildcard characters? false



-Token <AzureAccessToken>

The access token to use to connect.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-FunctionName <String>

Name of the higher function which is calling this function.



Required? false

Position? named

Default value $MyInvocation.MyCommand

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



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



PS C:\\>Invoke-MgaRestMethodGet -Field 'mailFolders' -Token $Token -User $User



Retrieves a list of email folders for the user $User, using the token stored in $Token











RELATED LINKS