Skip to content

Latest commit

 

History

History
240 lines (167 loc) · 10.8 KB

troubleshooting.md

File metadata and controls

240 lines (167 loc) · 10.8 KB
Raw
author discussion
BernieWhite
false

Troubleshooting

This article provides troubleshooting instructions for common errors.

Bicep compile errors

When expanding Bicep source files you may get an error including a BCPnnn code similar to the following:

!!! Message

Exception calling "GetResources" with "3" argument(s): "Bicep (0.14.46) compilation of '<file>' failed with: Error BCP057: The name "storageAccountName" does not exist in the current context.

This error is raised when Bicep fails to compile a source file. To resolve this issue:

  • You may need to update your Bicep source file before PSRule can expand it. Use guidance from the Bicep error message to help resolve the issue.
  • Check that you are using a version of Bicep that supports the Bicep features you are using. It may not always be clear which version of Bicep CLI PSRule for Azure is using if you have multiple versions installed. Using the Bicep CLI via az bicep is not the default, and you may need to set additional options to use it.

!!! Tip From PSRule for Azure v1.25.0 you can configure the minimum version of Bicep CLI required. If an earlier version is detected, PSRule for Azure will generate an error. See Configuring minimum version for details on how to configure this option.

Bicep version

When expanding Bicep source files you may get an error relating to the Bicep version you have installed. For example if you attempt to use a Bicep feature that is not supported by the version used by PSRule for Azure.

Check the Bicep version reported by PSRule supports the Bicep features you are using.

PSRule for Azure uses the Bicep CLI installed on your machine or CI worker. By default, the Bicep CLI binary will be selected by your PATH environment variable.

Optionally you can configure an alternative Bicep CLI binary to use by either:

For more details on installing and configuring the Bicep CLI, see Setup Bicep.

Bicep features

Generally PSRule for Azure plans to support any language features that are supported by the latest version of Bicep. New language features are often added behind an experimental feature flag for community feedback. Features flagged by Bicep as experimental may not be supported by PSRule for Azure immediately. PSRule for Azure will plan to add support as soon as possible after the feature flag is removed.

If you are using a Bicep feature that is not supported by PSRule for Azure, please join or start a discussion.

Bicep compilation timeout

When expanding Bicep source files you may get an error similar to the following:

!!! Message

Bicep (0.4.1124) compilation of 'C:\temp\deploy.bicep' failed with: Bicep compilation hasn't completed within the timeout window. This can be caused by errors or warnings. Check the Bicep output by running bicep build and addressing any issues.

This error is raised when Bicep takes longer then the timeout to build a source file. The default timeout is 5 seconds.

You can take steps to reduce your code complexity and reduce the time a build takes by:

  • Removing unnecessary nested module calls.
  • Cache bicep modules restored from a registry in continuous integration (CI) pipelines.

To increase the timeout value, set the AZURE_BICEP_FILE_EXPANSION_TIMEOUT configuration option. See Bicep compilation timeout for details on how to configure this option.

No rules or no Azure resources are found

There is a few common causes of this issue including:

  • Check input format — PSRule for Azure must discover files to expand them.
    • When running PSRule for Azure using GitHub Actions or the Azure Pipelines extension:
      • Your pipeline must be set to inputType: repository, which is the default value.
      • PSRule for Azure will not work with inputType set to inputPath.
      • You may have set this parameter because you wanted to use the inputPath parameter. Setting the inputType is not a requirement for using the inputPath parameter. The inputPath parameter can be used independently.
    • When running PSRule for Azure from PowerShell:
      • Your command-line must use the -Format File parameter.
      • Your command-line must use the -InputPath or -f parameter followed by a file or directory path.
      • For example: Assert-PSRule -Module PSRule.Rules.Azure -Format File -f 'modules/'.
  • Check expansion is enabled — Expansion must be enabled to analyze Azure Infrastructure as Code. See using templates and using Bicep source for details on how to enable expansion.
  • Check parameter files are linked — Parameter files must be linked to ARM templates or Bicep source files. See using templates for details on how to link using metadata or naming convention.

!!! Note If your pipeline is still not finding any Azure resources, please join or start a discussion.

Custom rules are not running

There is a few common causes of this issue including:

  • Check rule path — By default, PSRule will look for rules in the .ps-rule/ directory. This directory is the root for your repository or the current working path by default. On case-sensitive file systems such as Linux, this directory name is case-sensitive. See Storing and naming rules for more information.
  • Check file name suffix — PSRule only looks for files with the .Rule.ps1, .Rule.yaml, or .Rule.jsonc suffix. On case-sensitive file systems such as Linux, this file suffix is case-sensitive. See Storing and naming rules for more information.
  • Check binding configuration — PSRule uses binding to work out which property to use for a resource type. To be able to use the -Type parameter or type properties in rules definitions, binding must be set. This is automatically configured for PSRule for Azure, however must be set in ps-rule.yaml for custom rules. See binding type for more information.
  • Check modules — PSRule for Azure is responsible for expanding Azure resources from Infrastructure as Code. Expansion occurs automatically in memory when enabled. For this to work, the module PSRule.Rules.Azure must be run with any custom rules. See using templates and using Bicep source for details on how to enable expansion.
  • Check include local option — When running PSRule for Azure with a baseline. Baselines such as quarterly baselines may use filters to limit the rules that are included. As a result, custom rules may not be included. To include custom rules set the Rule.IncludeLocal option to true. See Including custom rules for more information.

!!! Tip You may be able to use git mv to change the case of a file if it is committed to the repository incorrectly.

Parameter file warns of metadata property

You may find while editing a .json parameter file the root metadata property is flagged with a warning.

!!! Message

The property 'metadata' is not allowed.

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "metadata": {
        "template": "./storage.template.json"
    },
    "parameters": {
    }
}

This doesn't affect the workings of the parameter file or deployment. The reason for the warning is that the metadata property has not been added to the parameter file JSON schema. However, the top level metadata property is ignored by Azure Resource Manager when deploying a template.

Issues with Az.Resources

The PowerShell module Az.Resources and Az.Accounts is currently used when exporting data from Azure. These modules are use when:

  • Exporting resources for in-flight analysis.
  • Exporting policy assignments for policy as rules.

These modules are not required if you only want to execute rules.

Suppression of Az.Resources warning

If you only intend to execute rules you can suppress the following warning message.

!!! Message

To use PSRule for Azure export cmdlets please install Az.Resources.

This message can be ignored if you are not exporting data from Azure. To suppress the warning configure the PSRULE_AZURE_RESOURCE_MODULE_NOWARN environment variable to true. For more details see Configuring exports.

Installing Az.Resources

If you plan on exporting data from Azure, you must install the Az.Resources module.

Some versions of Az.Resources are known to be incompatible with PSRule for Azure. As a result, we recommend installing and importing v6.7.0 to address these issues. A known incompatibility currently exists with v7.1.0 (#2970). By default, PowerShell will attempt to install or use a newer version already installed which may return an error.

!!! Message

ExpandPolicyAssignment: The property 'Properties' cannot be found on this object. Verify that the property exists.

To install a specific version use:

Install-Module Az.Resources -RequiredVersion '6.7.0' -Force -Scope CurrentUser

To import a specific version prior to using PSRule:

Import-Module Az.Resources -RequiredVersion '6.7.0'

Could not load file or assembly YamlDotNet

PSRule >=1.3.0 uses an updated version of the YamlDotNet library. The PSRule for Azure <1.3.1 uses an older version of this library which may conflict.

To avoid this issue:

  • Update to the latest version and use PSRule for Azure >=1.3.1 with PSRule >=1.3.0.
  • Alternatively, when using PSRule for Azure <1.3.1 use PSRule =1.2.0.

To install the latest module version of PSRule use the following commands:

Install-Module -Name PSRule.Rules.Azure -MinimumVersion 1.3.1 -Scope CurrentUser -Force;

For the PSRule GitHub Action, use >=1.4.0.

- name: Run PSRule analysis
  uses: microsoft/[email protected]