< Back

Get-PowerAppsCheckerRules

Sat Jan 18, 2020 3:51 pm

NAME Get-PowerAppsCheckerRules



SYNOPSIS

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



Obtains the list of rules for a specific ruleset or rulesets currently supported by the PowerApps checker service.





SYNTAX

Get-PowerAppsCheckerRules [-ApiUrl] <Uri> [-IncludeMessageFormats] [-LocaleName {bg | ca | cs | da | de | el | en

| es | et | eu | fi | fr | gl | hi | hr | hu | id | it | ja | kk | ko | lt | lv | ms | nb | nl | pl | pt-BR |

pt-pt | ro | ru | sk | sl | sr-Cyrl-RS | sr-Latn-RS | sv | th | tr | uk | vi | zh-HANS | zh-HANT}]

[-MaxConnectionTimeOutMinutes <Int32>] -Ruleset <Ruleset[]> [-TenantId <Guid>] [<CommonParameters>]



Get-PowerAppsCheckerRules [[-Geography] {PreviewUnitedStates | UnitedStates | Europe | Asia | Australia | Japan |

India | Canada | SouthAmerica | UnitedKingdom | France}] [-IncludeMessageFormats] [-LocaleName {bg | ca | cs | da

| de | el | en | es | et | eu | fi | fr | gl | hi | hr | hu | id | it | ja | kk | ko | lt | lv | ms | nb | nl | pl

| pt-BR | pt-pt | ro | ru | sk | sl | sr-Cyrl-RS | sr-Latn-RS | sv | th | tr | uk | vi | zh-HANS | zh-HANT}]

[-MaxConnectionTimeOutMinutes <Int32>] -Ruleset <Ruleset[]> [-TenantId <Guid>] [<CommonParameters>]





DESCRIPTION

The Get-PowerAppsCheckerRulesets cmdlet obtains the list of rules available, but the most common usage is to

obtain a list of rules included in a ruleset. An array of `Microsoft.PowerApps.Checker.Client.Models.Rule` objects

is returned.





PARAMETERS

-ApiUrl <Uri>

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

should be used.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Geography <ApiGeography>

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. It is

suggested to 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, it may reduce execution time as the data will not have to travel as far.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-IncludeMessageFormats [<SwitchParameter>]

When specified, includes all of the issue message variations available for the resulting rules in the `Locale`

specified. This can be used in cases where additional translations are being performed to provide the output

in a different language.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-LocaleName <String>

Specifies the language code that determines how the results are listed, such as es , for Spanish. The

languages that are supported are included in the validation set of the parameter.



Required? false

Position? named

Default value en

Accept pipeline input? False

Accept wildcard characters? false



-MaxConnectionTimeOutMinutes <Int32>

Maximum number in minutes to wait before quitting the operation.



Required? false

Position? named

Default value 2

Accept pipeline input? False

Accept wildcard characters? false



-Ruleset <Ruleset[]>

A ruleset is a collection of rules that are referenceable by name or Id. The `Get-PowerAppsCheckerRulesets`

cmdlet obtains the list of rulesets currently supported by the PowerApps checker service. The required type is

`Microsoft.PowerApps.Checker.Client.Models.Ruleset[]` The minimal requirement to be included is a valid value

for either the `Name` or `Id` property.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TenantId <Guid>

Id of the tenant that is requesting the information. For normal usage this is not necessary to provide. It is

also referred to as the directory Id.



Required? false

Position? named

Default value None

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.Management.Automation.SwitchParameter





Microsoft.PowerApps.Checker.Client.Models.Ruleset[]





System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]





System.Uri





System.String





Microsoft.PowerApps.Checker.PowerShell.ApiGeography





System.Int32







OUTPUTS

System.Object







NOTES





It is suggested that you periodically run this cmdlet to query the service for updates to the list of

available rulesets.



-------------------------- Example 1 --------------------------



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

PS C:\\> $rules = $rulesets | Get-PowerAppsCheckerRules -Geography Europe



Returns the rules available in all available rulesets in the geography.

-------------------------- Example 2 --------------------------



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

PS C:\\> $rules = $rulesets | Get-PowerAppsCheckerRules -Geography Europe -LocaleName es



Returns the rules available in all available rulesets in the geography with the `Description` and `Summary`

properties translated in Spanish.



RELATED LINKS

Online Version: https://go.microsoft.com/fwlink/?linkid=2094304

Find your Office 365 tenant ID https://docs.microsoft.com/onedrive/fin ... -tenant-id