Skip to main content
Version: 2.0.1 (preview)

Invoke-MtAzureRequest

SYNOPSISโ€‹

Invoke a REST API request to the Azure Management API.

SYNTAXโ€‹

Invoke-MtAzureRequest [-RelativeUri] <String> [[-Method] <String>] [[-ApiVersion] <Object>]
[[-Filter] <String>] [[-Select] <String>] [[-Payload] <String>] [-Graph] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTIONโ€‹

This function allows you to make REST API requests to the Azure Management API. It is a wrapper around the Invoke-AzRest function, providing a simplified interface.

EXAMPLESโ€‹

EXAMPLE 1โ€‹

Invoke-MtAzureRequest -RelativeUri 'subscriptions'

PARAMETERSโ€‹

-RelativeUriโ€‹

Graph endpoint such as "users".

Type: String
Parameter Sets: (All)
Aliases: Path

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Methodโ€‹

The HTTP method to use. Default is GET.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: GET
Accept pipeline input: False
Accept wildcard characters: False

-ApiVersionโ€‹

The API version to use. Default is 2024-11-01

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 2024-11-01
Accept pipeline input: False
Accept wildcard characters: False

-Filterโ€‹

Filter parameters to include in the request. E.g. "displayName eq 'John'"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Selectโ€‹

Select parameters to include in the request. E.g. "id,displayName"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Payloadโ€‹

The body payload for POST/PATCH/PUT requests

Type: String
Parameter Sets: (All)
Aliases: Body

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Graphโ€‹

Use Microsoft Graph endpoint. Defaults to Azure Resource Manager, if enabled requests will go to Microsoft Graph

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressActionโ€‹

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParametersโ€‹

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTSโ€‹

OUTPUTSโ€‹

NOTESโ€‹

https://maester.dev/docs/commands/Invoke-MtAzureRequest