Share via

Get-PowerAppsCheckerRulesets

Module:
Microsoft.PowerApps.Checker.PowerShell Module

This topic is pre-release documentation and is subject to change.

Obtains the list of rulesets currently supported by the PowerApps checker service.

Syntax

ServiceReqGeo (Default) 

Get-PowerAppsCheckerRulesets
    [[-Geography] <ApiGeography>]
    [-TenantId <Guid>]
    [-MaxConnectionTimeOutMinutes <Int32>]
    [<CommonParameters>]

ServiceReqApi 

Get-PowerAppsCheckerRulesets
    [-ApiUrl] <Uri>
    [-TenantId <Guid>]
    [-MaxConnectionTimeOutMinutes <Int32>]
    [<CommonParameters>]

Description

A ruleset is a collection of rules that can be referenced by name or Id. The Get-PowerAppsCheckerRulesets cmdlet obtains the list of rulesets currently supported by the PowerApps checker service. Both Get-PowerAppsCheckerRules and Invoke-PowerAppsChecker accept the result of this cmdlet as a parameter. An array of Microsoft.PowerApps.Checker.Client.Models.Ruleset objects is returned.

Examples

Example 1

PS C:\> $rulesets = Get-PowerAppsCheckerRulesets

Returns the list of rulesets currently supported by the PowerApps checker service using the region in the United States.

Example 2

PS C:\> $rulesets = Get-PowerAppsCheckerRulesets -Geography Europe

Returns the list of rulesets currently supported by the PowerApps checker service using the Europe geography.

Parameters

-ApiUrl

URL of the PowerApps checker root service endpoint. Unless provided a direct URL from Microsoft, Geography should be used.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ServiceReqApi
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Geography

When executing Invoke-PowerAppsChecker the PowerApps checker service temporarily stores the data that you upload in Azure along with the reports that are generated. By specifying a geography, you can control where the data is stored. If no geography is specified, then the United States preview region is used. We recommend that you specify the same geography that will be provided to Invoke-PowerAppsChecker. Each geography may have a different version at any given point in time and doing this ensures that there is version compatibility. In some cases, this can also reduce execution time as the data will not have to travel as far.

Parameter properties

Type:ApiGeography
Default value:PreviewUnitedStates
Accepted values:PreviewUnitedStates, UnitedStates, Europe, Asia, Australia, Japan, India, Canada, SouthAmerica, UnitedKingdom, France
Supports wildcards:False
DontShow:False

Parameter sets

ServiceReqGeo
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaxConnectionTimeOutMinutes

Maximum number in minutes to wait before quitting the operation.

Parameter properties

Type:Int32
Default value:2
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TenantId

Id of the tenant that is requesting the information. For normal usage this is not necessary to provide. This is also referred to as the directory Id.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

System.Nullable`1

System.Uri

Microsoft.PowerApps.Checker.PowerShell.ApiGeography

System.Int32

Outputs

System.Object

Notes

We recommend that you periodically run this cmdlet to query the service for updates to the list of available rulesets.